CreateChangeset -

CreateChangeset

Creates a new changeset in a FinSpace dataset.

Request Syntax

POST /datasets/datasetId/changesets HTTP/1.1 Content-type: application/json { "changeType": "string", "formatParams": { "string" : "string" }, "formatType": "string", "sourceParams": { "string" : "string" }, "sourceType": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.

datasetId

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

Length Constraints: Minimum length of 1. Maximum length of 26.

Required: Yes

Request Body

The request accepts the following data in JSON format.

changeType

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.

Type: String

Valid Values: REPLACE | APPEND | MODIFY

Required: Yes

sourceParams

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

Type: String to string map

Required: Yes

sourceType

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

  • S3 - Amazon S3.

Type: String

Valid Values: S3

Required: Yes

formatParams

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

Type: String to string map

Required: No

formatType

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

Type: String

Valid Values: CSV | JSON | PARQUET | XML

Required: No

tags

Metadata tags to apply to this changeset.

Type: String to string map

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "changeset": { "changesetArn": "string", "changesetLabels": { "string" : "string" }, "changeType": "string", "createTimestamp": number, "datasetId": "string", "errorInfo": { "errorCategory": "string", "errorMessage": "string" }, "formatParams": { "string" : "string" }, "formatType": "string", "id": "string", "sourceParams": { "string" : "string" }, "sourceType": "string", "status": "string", "updatedByChangesetId": "string", "updatesChangesetId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

changeset

Returns the changeset details.

Type: ChangesetInfo object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: