[ 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
--dataset-id <value>
--change-type <value>
--source-type <value>
--source-params <value>
[--format-type <value>]
[--format-params <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataset-id (string)

The unique identifier for the FinSpace dataset in which the changeset will be created.

--change-type (string)

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.

Possible values:

• REPLACE

• APPEND

• MODIFY

--source-type (string)

Type of the data source from which the files to create the changeset will be sourced.

• S3 - Amazon S3.

Possible values:

• S3

--source-params (map)

Source path from which the files to create the changeset will be sourced.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--format-type (string)

Format type of the input files being loaded into the changeset.

Possible values:

• CSV

• JSON

• PARQUET

• XML

--format-params (map)

Options that define the structure of the source file(s).

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--tags (map)

Metadata tags to apply to this changeset.

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.

See ‘aws help’ for descriptions of global parameters.

Output

changeset -> (structure)

Returns the changeset details.

id -> (string)

Unique identifier for a changeset.

changesetArn -> (string)

The ARN identifier of the changeset.

datasetId -> (string)

The unique identifier for the FinSpace dataset in which the changeset is created.

changeType -> (string)

Change type indicates how a changeset is applied to a dataset.

• REPLACE - Changeset is considered as a replacement to all prior loaded changesets.

• APPEND - Changeset is 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.

sourceType -> (string)

Type of the data source from which the files to create the changeset are sourced.

• S3 - Amazon S3.

sourceParams -> (map)

Source path from which the files to create the changeset are sourced.

key -> (string)

value -> (string)

formatType -> (string)

Format type of the input files loaded into the changeset.

formatParams -> (map)

Structure of the source file(s).

key -> (string)

value -> (string)

createTimestamp -> (timestamp)

The timestamp at which the changeset was created in FinSpace.

status -> (string)

The status of changeset creation operation.

errorInfo -> (structure)

The structure with error messages.

errorMessage -> (string)

The text of the error message.

errorCategory -> (string)

The category of the error.

• VALIDATION -The inputs to this request are invalid.

• SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please contact AWS support to increase quotas.

• ACCESS_DENIED - Missing required permission to perform this request.

• RESOURCE_NOT_FOUND - One or more inputs to this request were not found.

• THROTTLING - The system temporarily lacks sufficient resources to process the request.

• INTERNAL_SERVICE_EXCEPTION - An internal service error has occurred.

• CANCELLED - A user recoverable error has occurred.

changesetLabels -> (map)

Tags associated with the changeset.

key -> (string)

value -> (string)

updatesChangesetId -> (string)

Unique identifier of the changeset that is updated.

updatedByChangesetId -> (string)

Unique identifier of the changeset that is updated a changeset.