Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetChangeset

Get information about a Changeset.

Request Syntax


GET /datasets/datasetId/changesetsv2/changesetId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

changesetId

The unique identifier of the Changeset for which to get data.

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

Required: Yes

datasetId

The unique identifier for the FinSpace Dataset where the Changeset is created.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "activeFromTimestamp": number,
   "activeUntilTimestamp": number,
   "changesetArn": "string",
   "changesetId": "string",
   "changeType": "string",
   "createTime": number,
   "datasetId": "string",
   "errorInfo": { 
      "errorCategory": "string",
      "errorMessage": "string"
   },
   "formatParams": { 
      "string" : "string" 
   },
   "sourceParams": { 
      "string" : "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.

activeFromTimestamp

Beginning time from which the Changeset is active. 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.

Type: Long

activeUntilTimestamp

Time until which the Changeset is active. 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.

Type: Long

changesetArn

The ARN identifier of the Changeset.

Type: String

changesetId

The unique identifier for a Changeset.

Type: String

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

changeType

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

Type: String

Valid Values: REPLACE | APPEND | MODIFY

createTime

The timestamp at which the Changeset 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.

Type: Long

datasetId

The unique identifier for the FinSpace Dataset where the Changeset is created.

Type: String

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

errorInfo

The structure with error messages.

Type: ChangesetErrorInfo object

formatParams

Structure of the source file(s).

Type: String to string map

Key Length Constraints: Maximum length of 128.

Key Pattern: [\s\S]*\S[\s\S]*

Value Length Constraints: Maximum length of 1000.

Value Pattern: [\s\S]*\S[\s\S]*

sourceParams

Options that define the location of the data being ingested.

Type: String to string map

Key Length Constraints: Maximum length of 128.

Key Pattern: [\s\S]*\S[\s\S]*

Value Length Constraints: Maximum length of 1000.

Value Pattern: [\s\S]*\S[\s\S]*

status

The status of Changeset creation operation.

Type: String

Valid Values: PENDING | FAILED | SUCCESS | RUNNING | STOP_REQUESTED

updatedByChangesetId

The unique identifier of the updated Changeset.

Type: String

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

updatesChangesetId

The unique identifier of the Changeset that is being updated.

Type: String

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

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

ConflictException

The request conflicts with an existing resource.

HTTP Status Code: 409

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