Skip to main content
Server path: /turbot-pipes-workspaces | Type: Application | PCID required: Yes

Tools

ToolDescription
turbot_pipes_workspaces_org_workspace_commandRun org workspace command
turbot_pipes_workspaces_org_workspace_createCreate org workspace
turbot_pipes_workspaces_org_workspace_deleteDelete org workspace
turbot_pipes_workspaces_org_workspace_getGet org workspace
turbot_pipes_workspaces_org_workspace_listList org workspaces
turbot_pipes_workspaces_org_workspace_list_audit_logsOrg workspace audit logs
turbot_pipes_workspaces_org_workspace_member_createCreate Org Workspace Member
turbot_pipes_workspaces_org_workspace_member_deleteDelete Org Workspace Member
turbot_pipes_workspaces_org_workspace_member_getGet Org Workspace Member
turbot_pipes_workspaces_org_workspace_member_listList Organization Workspace Members
turbot_pipes_workspaces_org_workspace_member_updateUpdate Org Workspace Member
turbot_pipes_workspaces_org_workspace_post_queryQuery org workspace
turbot_pipes_workspaces_org_workspace_process_commandRun org workspace process command
turbot_pipes_workspaces_org_workspace_process_getGet org workspace process
turbot_pipes_workspaces_org_workspace_process_listList org workspace processes
turbot_pipes_workspaces_org_workspace_process_logList org workspace process logs
turbot_pipes_workspaces_org_workspace_schema_attachAttach a schema to an org workspace
turbot_pipes_workspaces_org_workspace_schema_detachDetach a schema from an org workspace
turbot_pipes_workspaces_org_workspace_schema_getGet org workspace schema
turbot_pipes_workspaces_org_workspace_schema_get_tableGet org workspace schema table
turbot_pipes_workspaces_org_workspace_schema_listList org workspace schemas
turbot_pipes_workspaces_org_workspace_schema_list_tablesList org workspace schema tables
turbot_pipes_workspaces_org_workspace_snapshot_createCreate org workspace snapshot
turbot_pipes_workspaces_org_workspace_snapshot_deleteDelete org workspace snapshot
turbot_pipes_workspaces_org_workspace_snapshot_getGet org workspace snapshot
turbot_pipes_workspaces_org_workspace_snapshot_listList org workspace snapshots
turbot_pipes_workspaces_org_workspace_snapshot_updateUpdate org workspace snapshot
turbot_pipes_workspaces_org_workspace_updateUpdate org workspace

turbot_pipes_workspaces_org_workspace_command

Run org workspace command Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org where we want to run the workspace command.
workspace_handlestringYesThe handle of the workspace where command will be executed.
commandstringYescommand

turbot_pipes_workspaces_org_workspace_create

Create org workspace Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization where we want to create the workspace.
db_volume_size_bytesintegerNodb_volume_size_bytes
desired_statestringNopaused is not yet supported for Workspace
handlestringYeshandle
instance_typestringNoinstance_type

turbot_pipes_workspaces_org_workspace_delete

Delete org workspace Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization where the workspace exist.
workspace_handlestringYesProvide the handle of the workspace which needs to be deleted.

turbot_pipes_workspaces_org_workspace_get

Get org workspace Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle for an organization where the workspace exist.
workspace_handlestringYesThe handle of the workspace whose detail needs to be fetched.

turbot_pipes_workspaces_org_workspace_list

List org workspaces Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization for which we want to list the workspace.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_workspaces_org_workspace_list_audit_logs

Org workspace audit logs Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesSpecify the org handle to get the audit logs.
workspace_handlestringYesThe handle of the workspace whose logs needs to be fetched.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_workspaces_org_workspace_member_create

Create Org Workspace Member Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesSpecify the handle of the organization where the member need to be invited.
workspace_handlestringYesSpecify the handle of the workspace where the member need to be invited.
handlestringYeshandle
rolestringYesrole

turbot_pipes_workspaces_org_workspace_member_delete

Delete Org Workspace Member Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesSpecify the handle of the organization where the member need to be invited.
workspace_handlestringYesSpecify the handle of the workspace where the member need to be invited.
user_handlestringYesSpecify the handle of the user whose information you want to retrive.

turbot_pipes_workspaces_org_workspace_member_get

Get Org Workspace Member Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesSpecify the handle of the organization where the member need to be invited.
workspace_handlestringYesSpecify the handle of the workspace where the member need to be invited.
user_handlestringYesSpecify the handle of the user whose information you want to retrive.

turbot_pipes_workspaces_org_workspace_member_list

List Organization Workspace Members Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesSpecify the handle of the organization where the member need to be invited.
workspace_handlestringYesSpecify the handle of the workspace where the member need to be invited.
qstringNoOptional free-text search to filter the org workspace members.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_workspaces_org_workspace_member_update

Update Org Workspace Member Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesSpecify the handle of the organization where the member need to be invited.
workspace_handlestringYesSpecify the handle of the workspace where the member need to be invited.
user_handlestringYesSpecify the handle of the user whose information you want to retrive.
rolestringYesrole

turbot_pipes_workspaces_org_workspace_post_query

Query org workspace Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org that the workspace belongs to.
workspace_handlestringYesThe handle of the workspace to query.
content_typestringNoThe required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.
bodystringYesThe sql query to perform against the org workspace.

turbot_pipes_workspaces_org_workspace_process_command

Run org workspace process command Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org where we want to run the workspace process command.
workspace_handlestringYesThe handle of the workspace where the process command will be executed.
process_idstringYesThe id of the process where the command will be executed against.
commandstringYescommand

turbot_pipes_workspaces_org_workspace_process_get

Get org workspace process Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org where the workspace exist.
workspace_handlestringYesThe handle of the workspace whose process needs to be fetched.
process_idstringYesThe id of the process to be fetched.

turbot_pipes_workspaces_org_workspace_process_list

List org workspace processes Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of an organization for which you want to list the processes.
workspace_handlestringYesThe handle of the workspace where you want to list the processes.
wherestringNoThe SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_workspaces_org_workspace_process_log

List org workspace process logs Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org for which you want to list process logs.
workspace_handlestringYesThe handle of the workspace where you want to list the process logs.
process_idstringYesThe id of the process where you want to list the process logs.
log_filestringYesThe process logs file to be fetched.
content_typestringYesThe required content type of the process logs.

turbot_pipes_workspaces_org_workspace_schema_attach

Attach a schema to an org workspace Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org that the workspace belongs to.
workspace_handlestringYesThe handle of the workspace where the schema will be attached.
aggregator_handlestringNoaggregator_handle
connection_folderstringNoconnection_folder
connection_handlestringNoconnection_handle

turbot_pipes_workspaces_org_workspace_schema_detach

Detach a schema from an org workspace Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org that the workspace belongs to.
workspace_handlestringYesThe handle of the workspace from which the schema will be detached.
schema_namestringYesThe name of the schema that will be detached.

turbot_pipes_workspaces_org_workspace_schema_get

Get org workspace schema Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org that the workspace belongs to.
workspace_handlestringYesThe handle of the workspace where the schema exists.
schema_namestringYesThe name of the schema whose detail needs to be fetched.

turbot_pipes_workspaces_org_workspace_schema_get_table

Get org workspace schema table Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org where the workspace belongs to.
workspace_handlestringYesThe handle of the workspace where the schema exists.
schema_namestringYesThe name of the schema to which the table belongs.
table_namestringYesThe name of the table whose detail needs to be fetched.

turbot_pipes_workspaces_org_workspace_schema_list

List org workspace schemas Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org that the workspace belongs to.
workspace_handlestringYesThe handle of the workspace to get the schemas for.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_workspaces_org_workspace_schema_list_tables

List org workspace schema tables Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org that the workspace belongs to.
workspace_handlestringYesThe handle of the workspace where the schema exists.
schema_namestringYesThe name of the schema whose detail needs to be fetched.

turbot_pipes_workspaces_org_workspace_snapshot_create

Create org workspace snapshot Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org to create the workspace snapshot for.
workspace_handlestringYesThe handle of the org workspace to create the snapshot for.
dataobjectYesdata
tagsobjectNotags
titlestringNoThe title of the snapshot.
visibilitystringNoThe visibility of the snapshot to create.

turbot_pipes_workspaces_org_workspace_snapshot_delete

Delete org workspace snapshot Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org that the workspace snapshot belongs to.
workspace_handlestringYesThe handle of the org workspace that the snapshot belongs to.
snapshot_idstringYesThe handle of the snapshot which needs to be deleted.

turbot_pipes_workspaces_org_workspace_snapshot_get

Get org workspace snapshot Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org that the workspace snapshot belongs to.
workspace_handlestringYesThe handle of the org workspace that the snapshot belongs to.
snapshot_idstringYesThe handle of the snapshot whose detail needs to be fetched.

turbot_pipes_workspaces_org_workspace_snapshot_list

List org workspace snapshots Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org to list the workspace snapshots for.
workspace_handlestringYesThe handle of the org workspace to list snapshots for.
wherestringNoThe SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_workspaces_org_workspace_snapshot_update

Update org workspace snapshot Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org that the workspace snapshot belongs to.
workspace_handlestringYesThe handle of the org workspace that the snapshot belongs to.
snapshot_idstringYesThe handle of the snapshot to update.
tagsobjectNotags
titlestringNoThe updated title for the snapshot.
visibilitystringNoThe updated visibility for the snapshot.

turbot_pipes_workspaces_org_workspace_update

Update org workspace Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization where the workspace exist.
workspace_handlestringYesThe handle of the workspace which needs to be updated.
db_volume_size_bytesintegerNodb_volume_size_bytes
desired_statestringNopaused is not yet supported for Workspace
handlestringNohandle
instance_typestringNothe updated instance type of the workspace
search_path_prefixany[]NoOptionally update the search path prefix for the Steampipe DB.