Table of Contents
A low-level client representing FinSpace Public API (FinSpace Data)
The FinSpace APIs let you take actions inside the FinSpace.
import boto3
client = boto3.client('finspace-data')
These are the available methods:
Check if an operation can be paginated.
Creates a new Changeset in a FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
response = client.create_changeset(
clientToken='string',
datasetId='string',
changeType='REPLACE'|'APPEND'|'MODIFY',
sourceParams={
'string': 'string'
},
formatParams={
'string': 'string'
}
)
A token used to ensure idempotency.
This field is autopopulated if not provided.
[REQUIRED]
The unique identifier for the FinSpace Dataset where the Changeset will be created.
[REQUIRED]
Option to indicate how a Changeset will be applied to a Dataset.
[REQUIRED]
Options that define the location of the data being ingested.
[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:
For example, you could specify the following for formatParams : "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }
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.
Exceptions
Creates a Dataview for a Dataset.
See also: AWS API Documentation
Request Syntax
response = client.create_data_view(
clientToken='string',
datasetId='string',
autoUpdate=True|False,
sortColumns=[
'string',
],
partitionColumns=[
'string',
],
asOfTimestamp=123,
destinationTypeParams={
'destinationType': 'string',
's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
's3DestinationExportFileFormatOptions': {
'string': 'string'
}
}
)
A token used to ensure idempotency.
This field is autopopulated if not provided.
[REQUIRED]
The unique Dataset identifier that is used to create a Dataview.
Columns to be used for sorting the data.
Ordered set of column names used to partition data.
[REQUIRED]
Options that define the destination type for the Dataview.
Destination type for a Dataview.
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.
Exceptions
Creates a new FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
response = 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',
]
}
}
)
A token used to ensure idempotency.
This field is autopopulated if not provided.
[REQUIRED]
Display title for a FinSpace Dataset.
[REQUIRED]
The format in which Dataset data is structured.
Contact information for a Dataset owner.
Name of the Dataset owner.
Phone number for the Dataset owner.
Email address for the Dataset owner.
[REQUIRED]
Permission group parameters for Dataset permissions.
The unique identifier of the PermissionGroup.
List of resource permissions.
Resource permission for a Dataset.
Permission for a resource.
Definition for a schema on a tabular Dataset.
The configuration for a schema on a tabular Dataset.
List of column definitions.
The definition of a column in a tabular Dataset.
Data type of a column.
Name for a column.
Description for a column.
List of column names used for primary key.
dict
Response Syntax
{
'datasetId': 'string'
}
Response Structure
(dict) -- The response from a CreateDataset operation
datasetId (string) --
The unique identifier for the created Dataset.
Exceptions
Deletes a FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
response = client.delete_dataset(
clientToken='string',
datasetId='string'
)
A token used to ensure idempotency.
This field is autopopulated if not provided.
[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.
Exceptions
Get information about a Changeset.
See also: AWS API Documentation
Request Syntax
response = client.get_changeset(
datasetId='string',
changesetId='string'
)
[REQUIRED]
The unique identifier for the FinSpace Dataset where the Changeset is created.
[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,
'activeFromTimestamp': 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.
sourceParams (dict) --
Options that define the location of the data being ingested.
formatParams (dict) --
Structure of the source file(s).
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.
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.
activeFromTimestamp (integer) -- Milliseconds since UTC epoch
updatesChangesetId (string) --
The unique identifier of the Changeset that is being updated.
updatedByChangesetId (string) --
The unique identifier of the updated Changeset.
Exceptions
Gets information about a Dataview.
See also: AWS API Documentation
Request Syntax
response = client.get_data_view(
dataViewId='string',
datasetId='string'
)
[REQUIRED]
The unique identifier for the Dataview.
[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',
's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
's3DestinationExportFileFormatOptions': {
'string': '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.
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.
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.
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.
s3DestinationExportFileFormat (string) -- Data View Export File Format
s3DestinationExportFileFormatOptions (dict) --
status (string) --
The status of a Dataview creation.
Exceptions
Returns information about a Dataset.
See also: AWS API Documentation
Request Syntax
response = client.get_dataset(
datasetId='string'
)
[REQUIRED]
The unique identifier for a Dataset.
{
'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
The unique identifier for a Dataset.
The ARN identifier of the Dataset.
Display title for a Dataset.
The format in which Dataset data is structured.
A description of the Dataset.
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.
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.
Definition for a schema on a tabular Dataset.
The configuration for a schema on a tabular Dataset.
List of column definitions.
The definition of a column in a tabular Dataset.
Data type of a column.
Name for a column.
Description for a column.
List of column names used for primary key.
The unique resource identifier for a Dataset.
Status of the Dataset creation.
Exceptions
Create a paginator for an operation.
Request programmatic credentials to use with FinSpace SDK.
See also: AWS API Documentation
Request Syntax
response = client.get_programmatic_access_credentials(
durationInMinutes=123,
environmentId='string'
)
[REQUIRED]
The FinSpace environment identifier.
dict
Response Syntax
{
'credentials': {
'accessKeyId': 'string',
'secretAccessKey': 'string',
'sessionToken': 'string'
},
'durationInMinutes': 123
}
Response Structure
(dict) -- Response for GetProgrammaticAccessCredentials operation
credentials (dict) --
Returns the programmatic credentials.
accessKeyId (string) --
The access key identifier.
secretAccessKey (string) --
The access key.
sessionToken (string) --
The session token.
durationInMinutes (integer) --
Returns the duration in which the credentials will remain valid.
Exceptions
Returns an object that can wait for some condition.
A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.
See also: AWS API Documentation
Request Syntax
response = client.get_working_location(
locationType='INGESTION'|'SAGEMAKER'
)
Specify the type of the working location.
{
's3Uri': 'string',
's3Path': 'string',
's3Bucket': 'string'
}
Response Structure
Returns the Amazon S3 URI for the working location.
Returns the Amazon S3 Path for the working location.
Returns the Amazon S3 bucket name for the working location.
Exceptions
Lists the FinSpace Changesets for a Dataset.
See also: AWS API Documentation
Request Syntax
response = client.list_changesets(
datasetId='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The unique identifier for the FinSpace Dataset to which the Changeset belongs.
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,
'activeFromTimestamp': 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.
sourceParams (dict) --
Options that define the location of the data being ingested.
formatParams (dict) --
Options that define the structure of the source file(s).
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.
errorInfo (dict) --
The structure with error messages.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
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.
activeFromTimestamp (integer) -- Milliseconds since UTC epoch
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.
Exceptions
Lists all available Dataviews for a Dataset.
See also: AWS API Documentation
Request Syntax
response = client.list_data_views(
datasetId='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The unique identifier of the Dataset for which to retrieve Dataviews.
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',
's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
's3DestinationExportFileFormatOptions': {
'string': '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.
sortColumns (list) --
Columns to be used for sorting the data.
status (string) --
The status of a Dataview creation.
errorInfo (dict) --
The structure with error messages.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
destinationTypeProperties (dict) --
Information about the Dataview destination.
destinationType (string) --
Destination type for a Dataview.
s3DestinationExportFileFormat (string) -- Data View Export File Format
s3DestinationExportFileFormatOptions (dict) --
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.
Exceptions
Lists all of the active Datasets that a user has access to.
See also: AWS API Documentation
Request Syntax
response = client.list_datasets(
nextToken='string',
maxResults=123
)
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.
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.
columnName (string) --
Name for a column.
columnDescription (string) --
Description for a column.
primaryKeyColumns (list) --
List of column names used for primary key.
alias (string) --
The unique resource identifier for a Dataset.
nextToken (string) --
A token indicating where a results page should begin.
Exceptions
Updates a FinSpace Changeset.
See also: AWS API Documentation
Request Syntax
response = client.update_changeset(
clientToken='string',
datasetId='string',
changesetId='string',
sourceParams={
'string': 'string'
},
formatParams={
'string': 'string'
}
)
A token used to ensure idempotency.
This field is autopopulated if not provided.
[REQUIRED]
The unique identifier for the FinSpace Dataset in which the Changeset is created.
[REQUIRED]
The unique identifier for the Changeset to update.
[REQUIRED]
Options that define the location of the data being ingested.
[REQUIRED]
Options that define the structure of the source file(s).
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.
Exceptions
Updates a FinSpace Dataset.
See also: AWS API Documentation
Request Syntax
response = 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',
]
}
}
)
A token used to ensure idempotency.
This field is autopopulated if not provided.
[REQUIRED]
The unique identifier for the Dataset to update.
[REQUIRED]
A display title for the Dataset.
[REQUIRED]
The format in which the Dataset data is structured.
Definition for a schema on a tabular Dataset.
The configuration for a schema on a tabular Dataset.
List of column definitions.
The definition of a column in a tabular Dataset.
Data type of a column.
Name for a column.
Description for a column.
List of column names used for primary key.
dict
Response Syntax
{
'datasetId': 'string'
}
Response Structure
(dict) -- The response from an UpdateDataset operation
datasetId (string) --
The unique identifier for updated Dataset.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_changesets')
Creates an iterator that will paginate through responses from FinSpaceData.Client.list_changesets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique identifier for the FinSpace Dataset to which the Changeset belongs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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,
'activeFromTimestamp': 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.
sourceParams (dict) --
Options that define the location of the data being ingested.
formatParams (dict) --
Options that define the structure of the source file(s).
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.
errorInfo (dict) --
The structure with error messages.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
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.
activeFromTimestamp (integer) -- Milliseconds since UTC epoch
updatesChangesetId (string) --
The unique identifier of the Changeset that is updated.
updatedByChangesetId (string) --
The unique identifier of the updated Changeset.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_data_views')
Creates an iterator that will paginate through responses from FinSpaceData.Client.list_data_views().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
datasetId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The unique identifier of the Dataset for which to retrieve Dataviews.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'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',
's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
's3DestinationExportFileFormatOptions': {
'string': 'string'
}
},
'autoUpdate': True|False,
'createTime': 123,
'lastModifiedTime': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
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.
sortColumns (list) --
Columns to be used for sorting the data.
status (string) --
The status of a Dataview creation.
errorInfo (dict) --
The structure with error messages.
errorMessage (string) --
The text of the error message.
errorCategory (string) --
The category of the error.
destinationTypeProperties (dict) --
Information about the Dataview destination.
destinationType (string) --
Destination type for a Dataview.
s3DestinationExportFileFormat (string) -- Data View Export File Format
s3DestinationExportFileFormatOptions (dict) --
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_datasets')
Creates an iterator that will paginate through responses from FinSpaceData.Client.list_datasets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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
List of Datasets.
The structure for a Dataset.
An identifier for a Dataset.
The ARN identifier of the Dataset.
Display title for a Dataset.
The format in which Dataset data is structured.
Description for a Dataset.
Contact information for a Dataset owner.
Name of the Dataset owner.
Phone number for the Dataset owner.
Email address for the Dataset owner.
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.
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.
Definition for a schema on a tabular Dataset.
The configuration for a schema on a tabular Dataset.
List of column definitions.
The definition of a column in a tabular Dataset.
Data type of a column.
Name for a column.
Description for a column.
List of column names used for primary key.
The unique resource identifier for a Dataset.
A token to resume pagination.