Dataiku applications¶

The API offers methods to:

Create and list instances of an application
Manipulate the manifest of an application

Reference documentation¶

class dataikuapi.dss.app.DSSApp(client, app_id)¶

A handle to interact with a app on the DSS instance. Do not create this class directly, instead use dataikuapi.DSSClient.get_app`()

create_instance(instance_key, instance_name, wait=True)¶

Creates a new instance of this app. Each instance. must have a globally unique instance key, separate from any project key across the whole DSS instance

Returns:

make_random_project_key()¶

create_temporary_instance()¶: Creates a new temporary instance of this app. The return value should be used as a Python context manager. Upon exit, the temporary app instance is deleted :return a TemporaryDSSAppInstance

list_instance_keys()¶

List the existing instances of this app

:return a list of instance keys, each as a string

list_instances()¶

List the existing instances of this app

Return type:	list of dicts

:return a list of instances, each as a dict containing at least a “projectKey” field

get_instance(instance_key)¶

get_manifest()¶

class dataikuapi.dss.app.DSSAppInstance(client, project_key)¶

get_as_project()¶: Get the dataikuapi.dss.project DSSProject corresponding to this app instance

get_manifest()¶: Get the app manifest for this instance, as a DSSAppManifest

class dataikuapi.dss.app.DSSAppManifest(client, raw_data, project_key=None)¶

get_raw()¶

get_all_actions()¶

get_runnable_scenarios()¶: Return the scenario identifiers that are declared as actions for this app

save()¶: Saves the changes to this manifest object back to the template project

class dataikuapi.dss.app.TemporaryDSSAppInstance(client, project_key)¶

internal class

close()¶