/turbot-pipes-workspaces | Type: Application | PCID required: Yes
Tools
turbot_pipes_workspaces_org_workspace_command
Run org workspace command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org where we want to run the workspace command. |
workspace_handle | string | Yes | — | The handle of the workspace where command will be executed. |
command | string | Yes | — | command |
turbot_pipes_workspaces_org_workspace_create
Create org workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization where we want to create the workspace. |
db_volume_size_bytes | integer | No | — | db_volume_size_bytes |
desired_state | string | No | — | paused is not yet supported for Workspace |
handle | string | Yes | — | handle |
instance_type | string | No | — | instance_type |
turbot_pipes_workspaces_org_workspace_delete
Delete org workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization where the workspace exist. |
workspace_handle | string | Yes | — | Provide the handle of the workspace which needs to be deleted. |
turbot_pipes_workspaces_org_workspace_get
Get org workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle for an organization where the workspace exist. |
workspace_handle | string | Yes | — | The handle of the workspace whose detail needs to be fetched. |
turbot_pipes_workspaces_org_workspace_list
List org workspaces Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization for which we want to list the workspace. |
limit | integer | No | — | The 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_token | string | No | — | When 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | Specify the org handle to get the audit logs. |
workspace_handle | string | Yes | — | The handle of the workspace whose logs needs to be fetched. |
limit | integer | No | — | The 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_token | string | No | — | When 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | Specify the handle of the organization where the member need to be invited. |
workspace_handle | string | Yes | — | Specify the handle of the workspace where the member need to be invited. |
handle | string | Yes | — | handle |
role | string | Yes | — | role |
turbot_pipes_workspaces_org_workspace_member_delete
Delete Org Workspace Member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | Specify the handle of the organization where the member need to be invited. |
workspace_handle | string | Yes | — | Specify the handle of the workspace where the member need to be invited. |
user_handle | string | Yes | — | Specify the handle of the user whose information you want to retrive. |
turbot_pipes_workspaces_org_workspace_member_get
Get Org Workspace Member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | Specify the handle of the organization where the member need to be invited. |
workspace_handle | string | Yes | — | Specify the handle of the workspace where the member need to be invited. |
user_handle | string | Yes | — | Specify the handle of the user whose information you want to retrive. |
turbot_pipes_workspaces_org_workspace_member_list
List Organization Workspace Members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | Specify the handle of the organization where the member need to be invited. |
workspace_handle | string | Yes | — | Specify the handle of the workspace where the member need to be invited. |
q | string | No | — | Optional free-text search to filter the org workspace members. |
limit | integer | No | — | The 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_token | string | No | — | When 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | Specify the handle of the organization where the member need to be invited. |
workspace_handle | string | Yes | — | Specify the handle of the workspace where the member need to be invited. |
user_handle | string | Yes | — | Specify the handle of the user whose information you want to retrive. |
role | string | Yes | — | role |
turbot_pipes_workspaces_org_workspace_post_query
Query org workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org that the workspace belongs to. |
workspace_handle | string | Yes | — | The handle of the workspace to query. |
content_type | string | No | — | The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown. |
body | string | Yes | — | The sql query to perform against the org workspace. |
turbot_pipes_workspaces_org_workspace_process_command
Run org workspace process command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org where we want to run the workspace process command. |
workspace_handle | string | Yes | — | The handle of the workspace where the process command will be executed. |
process_id | string | Yes | — | The id of the process where the command will be executed against. |
command | string | Yes | — | command |
turbot_pipes_workspaces_org_workspace_process_get
Get org workspace process Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org where the workspace exist. |
workspace_handle | string | Yes | — | The handle of the workspace whose process needs to be fetched. |
process_id | string | Yes | — | The id of the process to be fetched. |
turbot_pipes_workspaces_org_workspace_process_list
List org workspace processes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of an organization for which you want to list the processes. |
workspace_handle | string | Yes | — | The handle of the workspace where you want to list the processes. |
where | string | No | — | The 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. |
limit | integer | No | — | The 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_token | string | No | — | When 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org for which you want to list process logs. |
workspace_handle | string | Yes | — | The handle of the workspace where you want to list the process logs. |
process_id | string | Yes | — | The id of the process where you want to list the process logs. |
log_file | string | Yes | — | The process logs file to be fetched. |
content_type | string | Yes | — | The required content type of the process logs. |
turbot_pipes_workspaces_org_workspace_schema_attach
Attach a schema to an org workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org that the workspace belongs to. |
workspace_handle | string | Yes | — | The handle of the workspace where the schema will be attached. |
aggregator_handle | string | No | — | aggregator_handle |
connection_folder | string | No | — | connection_folder |
connection_handle | string | No | — | connection_handle |
turbot_pipes_workspaces_org_workspace_schema_detach
Detach a schema from an org workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org that the workspace belongs to. |
workspace_handle | string | Yes | — | The handle of the workspace from which the schema will be detached. |
schema_name | string | Yes | — | The name of the schema that will be detached. |
turbot_pipes_workspaces_org_workspace_schema_get
Get org workspace schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org that the workspace belongs to. |
workspace_handle | string | Yes | — | The handle of the workspace where the schema exists. |
schema_name | string | Yes | — | The name of the schema whose detail needs to be fetched. |
turbot_pipes_workspaces_org_workspace_schema_get_table
Get org workspace schema table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org where the workspace belongs to. |
workspace_handle | string | Yes | — | The handle of the workspace where the schema exists. |
schema_name | string | Yes | — | The name of the schema to which the table belongs. |
table_name | string | Yes | — | The name of the table whose detail needs to be fetched. |
turbot_pipes_workspaces_org_workspace_schema_list
List org workspace schemas Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org that the workspace belongs to. |
workspace_handle | string | Yes | — | The handle of the workspace to get the schemas for. |
limit | integer | No | — | The 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_token | string | No | — | When 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org that the workspace belongs to. |
workspace_handle | string | Yes | — | The handle of the workspace where the schema exists. |
schema_name | string | Yes | — | The name of the schema whose detail needs to be fetched. |
turbot_pipes_workspaces_org_workspace_snapshot_create
Create org workspace snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org to create the workspace snapshot for. |
workspace_handle | string | Yes | — | The handle of the org workspace to create the snapshot for. |
data | object | Yes | — | data |
tags | object | No | — | tags |
title | string | No | — | The title of the snapshot. |
visibility | string | No | — | The visibility of the snapshot to create. |
turbot_pipes_workspaces_org_workspace_snapshot_delete
Delete org workspace snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org that the workspace snapshot belongs to. |
workspace_handle | string | Yes | — | The handle of the org workspace that the snapshot belongs to. |
snapshot_id | string | Yes | — | The handle of the snapshot which needs to be deleted. |
turbot_pipes_workspaces_org_workspace_snapshot_get
Get org workspace snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org that the workspace snapshot belongs to. |
workspace_handle | string | Yes | — | The handle of the org workspace that the snapshot belongs to. |
snapshot_id | string | Yes | — | The handle of the snapshot whose detail needs to be fetched. |
turbot_pipes_workspaces_org_workspace_snapshot_list
List org workspace snapshots Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org to list the workspace snapshots for. |
workspace_handle | string | Yes | — | The handle of the org workspace to list snapshots for. |
where | string | No | — | The 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. |
limit | integer | No | — | The 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_token | string | No | — | When 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the org that the workspace snapshot belongs to. |
workspace_handle | string | Yes | — | The handle of the org workspace that the snapshot belongs to. |
snapshot_id | string | Yes | — | The handle of the snapshot to update. |
tags | object | No | — | tags |
title | string | No | — | The updated title for the snapshot. |
visibility | string | No | — | The updated visibility for the snapshot. |
turbot_pipes_workspaces_org_workspace_update
Update org workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_handle | string | Yes | — | The handle of the organization where the workspace exist. |
workspace_handle | string | Yes | — | The handle of the workspace which needs to be updated. |
db_volume_size_bytes | integer | No | — | db_volume_size_bytes |
desired_state | string | No | — | paused is not yet supported for Workspace |
handle | string | No | — | handle |
instance_type | string | No | — | the updated instance type of the workspace |
search_path_prefix | any[] | No | — | Optionally update the search path prefix for the Steampipe DB. |

