FinSpaceData / Client / create_dataset

create_dataset

FinSpaceData.Client.create_dataset(**kwargs)

Creates a new FinSpace Dataset.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

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',
            ]
        }
    }
)

Parameters:

• clientToken (string) –

  A token that ensures idempotency. This token expires in 10 minutes.

  This field is autopopulated if not provided.

• datasetTitle (string) –

  [REQUIRED]

  Display title for a FinSpace Dataset.

• kind (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.

• datasetDescription (string) – Description of a Dataset.

• ownerInfo (dict) –

  Contact information for a Dataset owner.

  • name (string) –

    The name of the Dataset owner.

  • phoneNumber (string) –

    Phone number for the Dataset owner.

  • email (string) –

    Email address for the Dataset owner.

• permissionGroupParams (dict) –

  [REQUIRED]

  Permission group parameters for Dataset permissions.

  • permissionGroupId (string) –

    The unique identifier for the PermissionGroup.

  • datasetPermissions (list) –

    List of resource permissions.

    • (dict) –

      Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.

      The following is a list of valid dataset permissions that you can apply:

      • ViewDatasetDetails

      • ReadDatasetDetails

      • AddDatasetData

      • CreateDataView

      • EditDatasetMetadata

      • DeleteDataset

      For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.

      • permission (string) –

        Permission for a resource.

• alias (string) – The unique resource identifier for a Dataset.

• 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) –

          The name of a column.

        • columnDescription (string) –

          Description for a column.

    • primaryKeyColumns (list) –

      List of column names used for primary key.

      • (string) – Column Name

Return type:

dict

Returns:

Response Syntax

{
    'datasetId': 'string'
}

Response Structure

• (dict) – The response from a CreateDataset operation

  • datasetId (string) –

    The unique identifier for the created Dataset.

Exceptions

• FinSpaceData.Client.exceptions.InternalServerException

• FinSpaceData.Client.exceptions.ValidationException

• FinSpaceData.Client.exceptions.ThrottlingException

• FinSpaceData.Client.exceptions.AccessDeniedException

• FinSpaceData.Client.exceptions.LimitExceededException

• FinSpaceData.Client.exceptions.ConflictException

• FinSpaceData.Client.exceptions.ResourceNotFoundException