datasets

Creates, updates, deletes, gets or lists a datasets resource.

Overview

Name	datasets
Type	Resource
Id	aws.finspace_data.datasets

Fields

The following fields are returned by SELECT queries:

get_dataset

Name	Datatype	Description
alias	string	The unique resource identifier for a Dataset. (pattern: <code>^alias/\S+</code>)
create_time	integer (int64)	Milliseconds since UTC epoch
dataset_arn	string	The ARN identifier of the Dataset.
dataset_description	string	Description of a dataset (pattern: <code>[\s\S]*</code>)
dataset_id	string	ID for a given Dataset
dataset_title	string	Title for a given Dataset (pattern: <code>.\S.</code>)
kind	string	Dataset Kind (TABULAR, NON_TABULAR)
last_modified_time	integer (int64)	Milliseconds since UTC epoch
schema_definition	object	A union of schema types.
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. (PENDING, FAILED, SUCCESS, RUNNING)

list_datasets

Name	Datatype	Description
alias	string	The unique resource identifier for a Dataset. (pattern: <code>^alias/\S+</code>)
create_time	integer (int64)	Milliseconds since UTC epoch
dataset_arn	string	The ARN identifier of the Dataset.
dataset_description	string	Description of a dataset (pattern: <code>[\s\S]*</code>)
dataset_id	string	ID for a given Dataset
dataset_title	string	Title for a given Dataset (pattern: <code>.\S.</code>)
kind	string	Dataset Kind (TABULAR, NON_TABULAR)
last_modified_time	integer (int64)	Milliseconds since UTC epoch
owner_info	object	A structure for Dataset owner info.
schema_definition	object	A union of schema types.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dataset	select	dataset_id, region		Returns information about a Dataset.
list_datasets	select	region	nextToken, maxResults	Lists all of the active Datasets that a user has access to.
create_dataset	insert	region, datasetTitle, kind, permissionGroupParams		Creates a new FinSpace Dataset.
update_dataset	update	dataset_id, region, datasetTitle, kind		Updates a FinSpace Dataset.
delete_dataset	delete	dataset_id, region	clientToken	Deletes a FinSpace Dataset.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dataset_id	string	The unique identifier of the Dataset to be deleted.
region	string	AWS region (default: us-east-1)
clientToken	string	A token that ensures idempotency. This token expires in 10 minutes.
maxResults	integer	The maximum number of results per page.
nextToken	string	A token that indicates where a results page should begin.

SELECT examples

get_dataset

Returns information about a Dataset.

SELECT
alias,
create_time,
dataset_arn,
dataset_description,
dataset_id,
dataset_title,
kind,
last_modified_time,
schema_definition,
status
FROM aws.finspace_data.datasets
WHERE dataset_id = '{{ dataset_id }}' -- required
AND region = '{{ region }}' -- required
;

list_datasets

Lists all of the active Datasets that a user has access to.

SELECT
alias,
create_time,
dataset_arn,
dataset_description,
dataset_id,
dataset_title,
kind,
last_modified_time,
owner_info,
schema_definition
FROM aws.finspace_data.datasets
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_dataset

Creates a new FinSpace Dataset.

INSERT INTO aws.finspace_data.datasets (
clientToken,
datasetTitle,
kind,
datasetDescription,
ownerInfo,
permissionGroupParams,
alias,
schemaDefinition,
region
)
SELECT 
'{{ clientToken }}',
'{{ datasetTitle }}' /* required */,
'{{ kind }}' /* required */,
'{{ datasetDescription }}',
'{{ ownerInfo }}',
'{{ permissionGroupParams }}' /* required */,
'{{ alias }}',
'{{ schemaDefinition }}',
'{{ region }}'
RETURNING
dataset_id
;

Manifest

# Description fields are for documentation purposes
- name: datasets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the datasets resource.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Idempotence Token for API operations
  - name: datasetTitle
    value: "{{ datasetTitle }}"
    description: |
      Title for a given Dataset
  - name: kind
    value: "{{ kind }}"
    description: |
      Dataset Kind
    valid_values: ['TABULAR', 'NON_TABULAR']
  - name: datasetDescription
    value: "{{ datasetDescription }}"
    description: |
      Description of a dataset
  - name: ownerInfo
    description: |
      A structure for Dataset owner info.
    value:
      name: "{{ name }}"
      phoneNumber: "{{ phoneNumber }}"
      email: "{{ email }}"
  - name: permissionGroupParams
    description: |
      Permission group parameters for Dataset permissions. Here is an example of how you could specify the PermissionGroupParams: { "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g", "datasetPermissions": [ {"permission": "ViewDatasetDetails"}, {"permission": "AddDatasetData"}, {"permission": "EditDatasetMetadata"}, {"permission": "DeleteDataset"} ] }
    value:
      permissionGroupId: "{{ permissionGroupId }}"
      datasetPermissions:
        - permission: "{{ permission }}"
  - name: alias
    value: "{{ alias }}"
  - name: schemaDefinition
    description: |
      A union of schema types.
    value:
      tabularSchemaConfig:
        columns:
          - dataType: "{{ dataType }}"
            columnName: "{{ columnName }}"
            columnDescription: "{{ columnDescription }}"
        primaryKeyColumns:
          - "{{ primaryKeyColumns }}"

UPDATE examples

update_dataset

Updates a FinSpace Dataset.

UPDATE aws.finspace_data.datasets
SET 
clientToken = '{{ clientToken }}',
datasetTitle = '{{ datasetTitle }}',
kind = '{{ kind }}',
datasetDescription = '{{ datasetDescription }}',
alias = '{{ alias }}',
schemaDefinition = '{{ schemaDefinition }}'
WHERE 
dataset_id = '{{ dataset_id }}' --required
AND region = '{{ region }}' --required
AND datasetTitle = '{{ datasetTitle }}' --required
AND kind = '{{ kind }}' --required
RETURNING
dataset_id;

DELETE examples

delete_dataset

Deletes a FinSpace Dataset.

DELETE FROM aws.finspace_data.datasets
WHERE dataset_id = '{{ dataset_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;