2021/11/22 - FinSpace Public API - 11 new 1 updated api methods
Changes Add new APIs for managing Datasets, Changesets, and Dataviews.
Creates a new FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
client.create_dataset(
clientToken='string',
datasetTitle='string',
kind='TABULAR'|'NON_TABULAR',
datasetDescription='string',
ownerInfo={
'name': 'string',
'phoneNumber': 'string',
'email': 'string'
},
permissionGroupParams={
'permissionGroupId': 'string',
'datasetPermissions': [
{
'permission': 'string'
},
]
},
alias='string',
schemaDefinition={
'tabularSchemaConfig': {
'columns': [
{
'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
'columnName': 'string',
'columnDescription': 'string'
},
],
'primaryKeyColumns': [
'string',
]
}
}
)
string
A token used to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
Display title for a FinSpace Dataset.
string
[REQUIRED]
The format in which Dataset data is structured.
TABULAR - Data is structured in a tabular format.
NON_TABULAR - Data is structured in a non-tabular format.
string
[REQUIRED]
Description of a Dataset.
dict
Contact information for a Dataset owner.
name (string) --
Name of the Dataset owner.
phoneNumber (string) --
Phone number for the Dataset owner.
email (string) --
Email address for the Dataset owner.
dict
[REQUIRED]
Permission group parameters for Dataset permissions.
permissionGroupId (string) --
The unique identifier of the PermissionGroup.
datasetPermissions (list) --
List of resource permissions.
(dict) --
Resource permission for a Dataset.
permission (string) --
Permission for a resource.
string
[REQUIRED]
The unique resource identifier for a Dataset.
dict
Definition for a schema on a tabular Dataset.
tabularSchemaConfig (dict) --
The configuration for a schema on a tabular Dataset.
columns (list) --
List of column definitions.
(dict) --
The definition of a column in a tabular Dataset.
dataType (string) --
Data type of a column.
STRING - A String data type. CHAR - A char data type. INTEGER - An integer data type. TINYINT - A tinyint data type. SMALLINT - A smallint data type. BIGINT - A bigint data type. FLOAT - A float data type. DOUBLE - A double data type. DATE - A date data type. DATETIME - A datetime data type. BOOLEAN - A boolean data type. BINARY - A binary data type.
columnName (string) --
Name for a column.
columnDescription (string) --
Description for a column.
primaryKeyColumns (list) --
List of column names used for primary key.
(string) -- Column Name
dict
Response Syntax
{
'datasetId': 'string'
}
Response Structure
(dict) -- The response from a CreateDataset operation
datasetId (string) --
The unique identifier for the created Dataset.
Returns information about a Dataset.
See also: AWS API Documentation
Request Syntax
client.get_dataset(
datasetId='string'
)
string
[REQUIRED]
The unique identifier for a Dataset.
dict
Response Syntax
{
'datasetId': 'string',
'datasetArn': 'string',
'datasetTitle': 'string',
'kind': 'TABULAR'|'NON_TABULAR',
'datasetDescription': 'string',
'createTime': 123,
'lastModifiedTime': 123,
'schemaDefinition': {
'tabularSchemaConfig': {
'columns': [
{
'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
'columnName': 'string',
'columnDescription': 'string'
},
],
'primaryKeyColumns': [
'string',
]
}
},
'alias': 'string',
'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'
}
Response Structure
(dict) -- Response for the GetDataset operation
datasetId (string) --
The unique identifier for a Dataset.
datasetArn (string) --
The ARN identifier of the Dataset.
datasetTitle (string) --
Display title for a Dataset.
kind (string) --
The format in which Dataset data is structured.
TABULAR - Data is structured in a tabular format.
NON_TABULAR - Data is structured in a non-tabular format.
datasetDescription (string) --
A description of the Dataset.
createTime (integer) --
The timestamp at which the Dataset 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.
lastModifiedTime (integer) --
The last time that the Dataset was modified. 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.
schemaDefinition (dict) --
Definition for a schema on a tabular Dataset.
tabularSchemaConfig (dict) --
The configuration for a schema on a tabular Dataset.
columns (list) --
List of column definitions.
(dict) --
The definition of a column in a tabular Dataset.
dataType (string) --
Data type of a column.
STRING - A String data type. CHAR - A char data type. INTEGER - An integer data type. TINYINT - A tinyint data type. SMALLINT - A smallint data type. BIGINT - A bigint data type. FLOAT - A float data type. DOUBLE - A double data type. DATE - A date data type. DATETIME - A datetime data type. BOOLEAN - A boolean data type. BINARY - A binary data type.
columnName (string) --
Name for a column.
columnDescription (string) --
Description for a column.
primaryKeyColumns (list) --
List of column names used for primary key.
(string) -- Column Name
alias (string) --
The unique resource identifier for a Dataset.
status (string) --
Status of the Dataset creation.
PENDING - Dataset is pending creation.
FAILED - Dataset creation has failed.
SUCCESS - Dataset creation has succeeded.
RUNNING - Dataset creation is running.
Lists the FinSpace Changesets for a Dataset.
See also: AWS API Documentation
Request Syntax
client.list_changesets(
datasetId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier for the FinSpace Dataset to which the Changeset belongs.
integer
The maximum number of results per page.
string
A token indicating where a results page should begin.
dict
Response Syntax
{
'changesets': [
{
'changesetId': 'string',
'changesetArn': 'string',
'datasetId': 'string',
'changeType': 'REPLACE'|'APPEND'|'MODIFY',
'sourceParams': {
'string': 'string'
},
'formatParams': {
'string': 'string'
},
'createTime': 123,
'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'|'STOP_REQUESTED',
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'activeUntilTimestamp': 123,
'updatesChangesetId': 'string',
'updatedByChangesetId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) -- Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.
changesets (list) --
List of Changesets found.
(dict) --
A Changeset is unit of data in a Dataset.
changesetId (string) --
The 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) --
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.
sourceParams (dict) --
Options that define the location of the data being ingested.
(string) --
(string) --
formatParams (dict) --
Options that define the structure of the source file(s).
(string) --
(string) --
createTime (integer) --
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.
status (string) --
Status of the Changeset ingestion.
PENDING - Changeset is pending creation.
FAILED - Changeset creation has failed.
SUCCESS - Changeset creation has succeeded.
RUNNING - Changeset creation is running.
STOP_REQUESTED - User requested Changeset creation to stop.
errorInfo (dict) --
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 - Cancelled.
USER_RECOVERABLE - A user recoverable error has occurred.
activeUntilTimestamp (integer) --
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.
updatesChangesetId (string) --
The unique identifier of the Changeset that is updated.
updatedByChangesetId (string) --
The unique identifier of the updated Changeset.
nextToken (string) --
A token indicating where a results page should begin.
Get information about a Changeset.
See also: AWS API Documentation
Request Syntax
client.get_changeset(
datasetId='string',
changesetId='string'
)
string
[REQUIRED]
The unique identifier for the FinSpace Dataset where the Changeset is created.
string
[REQUIRED]
The unique identifier of the Changeset for which to get data.
dict
Response Syntax
{
'changesetId': 'string',
'changesetArn': 'string',
'datasetId': 'string',
'changeType': 'REPLACE'|'APPEND'|'MODIFY',
'sourceParams': {
'string': 'string'
},
'formatParams': {
'string': 'string'
},
'createTime': 123,
'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'|'STOP_REQUESTED',
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'activeUntilTimestamp': 123,
'updatesChangesetId': 'string',
'updatedByChangesetId': 'string'
}
Response Structure
(dict) -- The response from a describe changeset operation
changesetId (string) --
The unique identifier for a Changeset.
changesetArn (string) --
The ARN identifier of the Changeset.
datasetId (string) --
The unique identifier for the FinSpace Dataset where the Changeset is created.
changeType (string) --
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.
sourceParams (dict) --
Options that define the location of the data being ingested.
(string) --
(string) --
formatParams (dict) --
Structure of the source file(s).
(string) --
(string) --
createTime (integer) --
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.
status (string) --
The status of Changeset creation operation.
errorInfo (dict) --
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 - Cancelled.
USER_RECOVERABLE - A user recoverable error has occurred.
activeUntilTimestamp (integer) --
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.
updatesChangesetId (string) --
The unique identifier of the Changeset that is being updated.
updatedByChangesetId (string) --
The unique identifier of the updated Changeset.
Updates a FinSpace Changeset.
See also: AWS API Documentation
Request Syntax
client.update_changeset(
clientToken='string',
datasetId='string',
changesetId='string',
sourceParams={
'string': 'string'
},
formatParams={
'string': 'string'
}
)
string
A token used to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier for the FinSpace Dataset in which the Changeset is created.
string
[REQUIRED]
The unique identifier for the Changeset to update.
dict
[REQUIRED]
Options that define the location of the data being ingested.
(string) --
(string) --
dict
[REQUIRED]
Options that define the structure of the source file(s).
(string) --
(string) --
dict
Response Syntax
{
'changesetId': 'string',
'datasetId': 'string'
}
Response Structure
(dict) -- The response from a update changeset operation.
changesetId (string) --
The unique identifier for the Changeset to update.
datasetId (string) --
The unique identifier for the FinSpace Dataset in which the Changeset is created.
Deletes a FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
client.delete_dataset(
clientToken='string',
datasetId='string'
)
string
A token used to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the Dataset to be deleted.
dict
Response Syntax
{
'datasetId': 'string'
}
Response Structure
(dict) -- The response from an DeleteDataset operation
datasetId (string) --
The unique identifier for the deleted Dataset.
Lists all available Dataviews for a Dataset.
See also: AWS API Documentation
Request Syntax
client.list_data_views(
datasetId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the Dataset for which to retrieve Dataviews.
string
A token indicating where a results page should begin.
integer
The maximum number of results per page.
dict
Response Syntax
{
'nextToken': 'string',
'dataViews': [
{
'dataViewId': 'string',
'dataViewArn': 'string',
'datasetId': 'string',
'asOfTimestamp': 123,
'partitionColumns': [
'string',
],
'sortColumns': [
'string',
],
'status': 'RUNNING'|'STARTING'|'FAILED'|'CANCELLED'|'TIMEOUT'|'SUCCESS'|'PENDING'|'FAILED_CLEANUP_FAILED',
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'destinationTypeProperties': {
'destinationType': 'string'
},
'autoUpdate': True|False,
'createTime': 123,
'lastModifiedTime': 123
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token indicating where a results page should begin.
dataViews (list) --
A list of Dataviews.
(dict) --
Structure for the summary of a Dataview.
dataViewId (string) --
The unique identifier for the Dataview.
dataViewArn (string) --
The ARN identifier of the Dataview.
datasetId (string) --
Th unique identifier for the Dataview Dataset.
asOfTimestamp (integer) --
Time range 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.
partitionColumns (list) --
Ordered set of column names used to partition data.
(string) -- 1 - 255 character String
sortColumns (list) --
Columns to be used for sorting the data.
(string) -- 1 - 255 character String
status (string) --
The status of a Dataview creation.
RUNNING - Dataview creation is running.
STARTING - Dataview creation is starting.
FAILED - Dataview creation has failed.
CANCELLED - Dataview creation has been cancelled.
TIMEOUT - Dataview creation has timed out.
SUCCESS - Dataview creation has succeeded.
PENDING - Dataview creation is pending.
FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.
errorInfo (dict) --
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 - Cancelled.
USER_RECOVERABLE - A user recoverable error has occurred.
destinationTypeProperties (dict) --
Information about the Dataview destination.
destinationType (string) --
Destination type for a Dataview.
GLUE_TABLE - Glue table destination type.
autoUpdate (boolean) --
The flag to indicate Dataview should be updated automatically.
createTime (integer) --
The timestamp at which the Dataview 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.
lastModifiedTime (integer) --
The last time that a Dataview was modified. 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.
Lists all of the active Datasets that a user has access to.
See also: AWS API Documentation
Request Syntax
client.list_datasets(
nextToken='string',
maxResults=123
)
string
A token indicating where a results page should begin.
integer
The maximum number of results per page.
dict
Response Syntax
{
'datasets': [
{
'datasetId': 'string',
'datasetArn': 'string',
'datasetTitle': 'string',
'kind': 'TABULAR'|'NON_TABULAR',
'datasetDescription': 'string',
'ownerInfo': {
'name': 'string',
'phoneNumber': 'string',
'email': 'string'
},
'createTime': 123,
'lastModifiedTime': 123,
'schemaDefinition': {
'tabularSchemaConfig': {
'columns': [
{
'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
'columnName': 'string',
'columnDescription': 'string'
},
],
'primaryKeyColumns': [
'string',
]
}
},
'alias': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) -- Response for the ListDatasets operation
datasets (list) --
List of Datasets.
(dict) --
The structure for a Dataset.
datasetId (string) --
An identifier for a Dataset.
datasetArn (string) --
The ARN identifier of the Dataset.
datasetTitle (string) --
Display title for a Dataset.
kind (string) --
The format in which Dataset data is structured.
TABULAR - Data is structured in a tabular format.
NON_TABULAR - Data is structured in a non-tabular format.
datasetDescription (string) --
Description for a Dataset.
ownerInfo (dict) --
Contact information for a Dataset owner.
name (string) --
Name of the Dataset owner.
phoneNumber (string) --
Phone number for the Dataset owner.
email (string) --
Email address for the Dataset owner.
createTime (integer) --
The timestamp at which the Dataset 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.
lastModifiedTime (integer) --
The last time that the Dataset was modified. 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.
schemaDefinition (dict) --
Definition for a schema on a tabular Dataset.
tabularSchemaConfig (dict) --
The configuration for a schema on a tabular Dataset.
columns (list) --
List of column definitions.
(dict) --
The definition of a column in a tabular Dataset.
dataType (string) --
Data type of a column.
STRING - A String data type. CHAR - A char data type. INTEGER - An integer data type. TINYINT - A tinyint data type. SMALLINT - A smallint data type. BIGINT - A bigint data type. FLOAT - A float data type. DOUBLE - A double data type. DATE - A date data type. DATETIME - A datetime data type. BOOLEAN - A boolean data type. BINARY - A binary data type.
columnName (string) --
Name for a column.
columnDescription (string) --
Description for a column.
primaryKeyColumns (list) --
List of column names used for primary key.
(string) -- Column Name
alias (string) --
The unique resource identifier for a Dataset.
nextToken (string) --
A token indicating where a results page should begin.
Creates a Dataview for a Dataset.
See also: AWS API Documentation
Request Syntax
client.create_data_view(
clientToken='string',
datasetId='string',
autoUpdate=True|False,
sortColumns=[
'string',
],
partitionColumns=[
'string',
],
asOfTimestamp=123,
destinationTypeParams={
'destinationType': 'string'
}
)
string
A token used to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique Dataset identifier that is used to create a Dataview.
boolean
Flag to indicate Dataview should be updated automatically.
list
Columns to be used for sorting the data.
(string) -- 1 - 255 character String
list
Ordered set of column names used to partition data.
(string) -- 1 - 255 character String
integer
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.
dict
[REQUIRED]
Options that define the destination type for the Dataview.
destinationType (string) -- [REQUIRED]
Destination type for a Dataview.
GLUE_TABLE - Glue table destination type.
dict
Response Syntax
{
'datasetId': 'string',
'dataViewId': 'string'
}
Response Structure
(dict) -- Response for creating a data view.
datasetId (string) --
The unique identifier of the Dataset used for the Dataview.
dataViewId (string) --
The unique identifier for the created Dataview.
Updates a FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
client.update_dataset(
clientToken='string',
datasetId='string',
datasetTitle='string',
kind='TABULAR'|'NON_TABULAR',
datasetDescription='string',
alias='string',
schemaDefinition={
'tabularSchemaConfig': {
'columns': [
{
'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
'columnName': 'string',
'columnDescription': 'string'
},
],
'primaryKeyColumns': [
'string',
]
}
}
)
string
A token used to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier for the Dataset to update.
string
[REQUIRED]
A display title for the Dataset.
string
[REQUIRED]
The format in which the Dataset data is structured.
TABULAR - Data is structured in a tabular format.
NON_TABULAR - Data is structured in a non-tabular format.
string
A description for the Dataset.
string
[REQUIRED]
The unique resource identifier for a Dataset.
dict
Definition for a schema on a tabular Dataset.
tabularSchemaConfig (dict) --
The configuration for a schema on a tabular Dataset.
columns (list) --
List of column definitions.
(dict) --
The definition of a column in a tabular Dataset.
dataType (string) --
Data type of a column.
STRING - A String data type. CHAR - A char data type. INTEGER - An integer data type. TINYINT - A tinyint data type. SMALLINT - A smallint data type. BIGINT - A bigint data type. FLOAT - A float data type. DOUBLE - A double data type. DATE - A date data type. DATETIME - A datetime data type. BOOLEAN - A boolean data type. BINARY - A binary data type.
columnName (string) --
Name for a column.
columnDescription (string) --
Description for a column.
primaryKeyColumns (list) --
List of column names used for primary key.
(string) -- Column Name
dict
Response Syntax
{
'datasetId': 'string'
}
Response Structure
(dict) -- The response from an UpdateDataset operation
datasetId (string) --
The unique identifier for updated Dataset.
Gets information about a Dataview.
See also: AWS API Documentation
Request Syntax
client.get_data_view(
dataViewId='string',
datasetId='string'
)
string
[REQUIRED]
The unique identifier for the Dataview.
string
[REQUIRED]
The unique identifier for the Dataset used in the Dataview.
dict
Response Syntax
{
'autoUpdate': True|False,
'partitionColumns': [
'string',
],
'datasetId': 'string',
'asOfTimestamp': 123,
'errorInfo': {
'errorMessage': 'string',
'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
},
'lastModifiedTime': 123,
'createTime': 123,
'sortColumns': [
'string',
],
'dataViewId': 'string',
'dataViewArn': 'string',
'destinationTypeParams': {
'destinationType': 'string'
},
'status': 'RUNNING'|'STARTING'|'FAILED'|'CANCELLED'|'TIMEOUT'|'SUCCESS'|'PENDING'|'FAILED_CLEANUP_FAILED'
}
Response Structure
(dict) -- Response from retrieving a dataview, which includes details on the target database and table name
autoUpdate (boolean) --
Flag to indicate Dataview should be updated automatically.
partitionColumns (list) --
Ordered set of column names used to partition data.
(string) -- 1 - 255 character String
datasetId (string) --
The unique identifier for the Dataset used in the Dataview.
asOfTimestamp (integer) --
Time range 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.
errorInfo (dict) --
Information about an error that occurred for the Dataview.
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 - Cancelled.
USER_RECOVERABLE - A user recoverable error has occurred.
lastModifiedTime (integer) --
The last time that a Dataview was modified. 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.
createTime (integer) --
The timestamp at which the Dataview 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.
sortColumns (list) --
Columns to be used for sorting the data.
(string) -- 1 - 255 character String
dataViewId (string) --
The unique identifier for the Dataview.
dataViewArn (string) --
The ARN identifier of the Dataview.
destinationTypeParams (dict) --
Options that define the destination type for the Dataview.
destinationType (string) --
Destination type for a Dataview.
GLUE_TABLE - Glue table destination type.
status (string) --
The status of a Dataview creation.
RUNNING - Dataview creation is running.
STARTING - Dataview creation is starting.
FAILED - Dataview creation has failed.
CANCELLED - Dataview creation has been cancelled.
TIMEOUT - Dataview creation has timed out.
SUCCESS - Dataview creation has succeeded.
PENDING - Dataview creation is pending.
FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.
{'clientToken': 'string'}
Response {'changesetId': 'string', 'datasetId': 'string'}
Creates a new Changeset in a FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
client.create_changeset(
clientToken='string',
datasetId='string',
changeType='REPLACE'|'APPEND'|'MODIFY',
sourceParams={
'string': 'string'
},
formatParams={
'string': 'string'
}
)
string
A token used to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier for the FinSpace Dataset where the Changeset will be created.
string
[REQUIRED]
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.
dict
[REQUIRED]
Options that define the location of the data being ingested.
(string) --
(string) --
dict
[REQUIRED]
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.
For example, you could specify the following for formatParams :
(string) --
(string) --
dict
Response Syntax
{
'datasetId': 'string',
'changesetId': 'string'
}
Response Structure
(dict) -- The response from a CreateChangeset operation.
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.