Turbot Pipes

These are the Turbot Pipes actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Create org connection

  Tool to create a new connection for an organization. Use when you need to establish a new connection with a specific plugin (e.g., AWS, GCP, Azure) in an organization.

• Create Org Connection Folder

  Tool to create a new connection folder for an organization. Use when you need to create a connection folder in an org to organize connections.

• Create Org Workspace Aggregator

  Tool to create an aggregator for a workspace of an organization. Use when you need to add a new aggregator to a specific organization's workspace.

• Create Org Workspace Connection

  Tool to create a connection on an org workspace or associate an existing org connection to the workspace. Use when you need to create or link a connection to an organization's workspace.

• Create Org Workspace Connection Folder

  Tool to create a connection folder in a workspace of an organization. Use when you need to organize connections into folders within an org workspace.

• Create User AI Key

  Tool to create a new AI provider API key at the user level. Use when you need to configure AI provider credentials for a specific user in Turbot Pipes.

• Create User Connection

  Tool to create a new connection for a user. Use when you need to establish a new connection with a specific plugin (e.g., AWS, GCP, Azure) for a user account.

• Create User Integration

  Tool to create a new integration for a user. Use when you need to create a new integration for a specific user by providing the user handle, integration handle, and type.

• Create User Notifier

  Tool to create a new notifier for a user. Use when you need to configure notification endpoints for a specific user in Turbot Pipes.

• Create User Password

  Tool to create or rotate a user password. Use when you need to generate a new password for a user or reset an existing one.

• Create User Signup

  Tool to create a new user account via signup. Use when registering a new user with their email address.

• Create User Workspace Connection

  Tool to create a connection on a workspace for a user. Use when you need to create or link a connection to a user's workspace.

• Create User Workspace Connection Folder

  Tool to create a connection folder in a workspace of a user. Use when you need to organize connections into folders within a user workspace.

• Create User Workspace Datatank

  Tool to create a new user workspace Datatank. Use when you need to create a new Datatank for data storage in a user's workspace.

• Create User Workspace Datatank Table

  Tool to create a new user workspace datatank table. Use when you need to create a table within a user's workspace datatank for data storage and querying.

• Create User Workspace Mod Variable Setting

  Tool to create a setting for a mod variable in a user workspace. Use when you need to configure a variable for a mod installed in a user's workspace.

• Create User Workspace Notifier

  Tool to create a new notifier for a user workspace. Use when you need to configure a notification endpoint (e.g., Slack, email) for a specific workspace.

• Delete Org Billing Subscription

  Tool to delete an organization billing subscription. Schedules cancellation at the end of the current period. Use when you need to cancel an org subscription after confirming the org handle and subscription ID.

• Delete Org Connection Permission

  Tool to delete permission for a connection defined on an org. Use when you need to revoke a specific permission from an org connection.

• Delete Org Workspace Conversation

  Tool to delete a specific org workspace conversation. Use when you need to remove an AI conversation from an organization workspace after confirming the org handle, workspace handle, and conversation ID.

• Delete Org Workspace Mod Variable Setting

  Tool to delete setting for a mod variable in an organization workspace. Use when you need to remove a custom setting for a mod variable in a specific workspace.

• Delete Organization

  Tool to delete a specified organization if you have appropriate access. Use when you need to permanently remove an organization and have confirmed the org handle.

• Delete Organization Workspace

  Tool to delete an organization workspace. Use when you need to permanently remove a workspace from an organization after confirming org and workspace handles.

• Delete User Avatar

  Tool to delete custom avatar for a user. Use when you need to remove a user's custom avatar and revert to default.

• Delete User Token

  Tool to delete a specific user token. Use when you need to revoke a user's token after confirming handle and token ID.

• Delete User Workspace Mod Variable Setting

  Tool to delete a mod variable setting in a user workspace. Use when you need to remove a variable configuration from a mod installed in a user's workspace.

• Delete User Workspace Notifier

  Tool to delete a notifier for a user workspace. Use when you need to remove a notification configuration from a specific workspace.

• Delete User Workspace Pipeline

  Tool to delete a pipeline from a user's workspace. Use when you need to remove a specific pipeline by its ID from a workspace.

• Get Auth Provider

  Tool to initiate OAuth authentication flow with a provider. Use when you need to start the OAuth authorization process for GitHub, Google, or SAML authentication.

• Get Authenticated Actor

  Tool to retrieve the authenticated actor. Use when you need details about the currently authenticated actor after obtaining a valid token.

• Get Identity

  Tool to retrieve a specific identity by handle. Use when you need details of an identity by its handle after authenticating.

• Get Identity Avatar

  Tool to retrieve avatar image for an identity. Use when you need to display or download the user's avatar after knowing their identity handle.

• Get Org Workspace Integration

  Tool to get details of an integration available for a workspace belonging to an organization. Use when you need to retrieve information about a specific integration configured for a workspace within an organization.

• Get Org Workspace Notifier

  Tool to retrieve a notifier from an org workspace. Use when you need to get details about a specific notification endpoint configured for an organization's workspace.

• Get Organization

  Tool to retrieve organization information by handle. Use when you need details about a specific organization.

• Get Organization Integration

  Tool to get details of an integration configured on an organization. Use when you need to retrieve information about a specific integration by its handle and organization handle.

• Get Tenant

  Tool to retrieve tenant information by handle. Use when you need details about a specific tenant.

• Get Tenant Settings

  Tool to retrieve tenant settings. Use when you need to view the current configuration for the tenant, including login methods, session timeouts, and user provisioning settings.

• Get User

  Tool to retrieve user information by handle. Use when you need details about a specific user.

• Get User Connection

  Tool to retrieve details of a connection belonging to a user. Use when you need to fetch information about a specific user connection by user handle and connection handle.

• Get User Database Password

  Tool to retrieve user database password. Use when you need to get the database password for a specific user by their handle.

• Get User Email

  Tool to retrieve a specific user email record with metadata. Use when you need details about a user's email verification status and metadata.

• Get User Integration

  Tool to get details of an integration configured on a user. Use when you need to retrieve information about a specific user integration by providing the user handle and integration handle.

• Get User Preferences

  Tool to retrieve user preferences including email subscription settings. Use when you need to check a user's communication preferences.

• Get User Process

  Tool to retrieve process information for a user. Use when you need details about a specific process associated with a user.

• Get User Token

  Tool to retrieve details of a specific user token. Use when you need to inspect token metadata (e.g., creation time and scopes) after confirming the user handle and token ID.

• Get User Workspace Aggregator

  Tool to get the details of an aggregator belonging to a workspace of a user. Use when you need to retrieve information about a specific aggregator in a user's workspace.

• Get User Workspace Conversation

  Tool to retrieve details for a specific user workspace conversation. Use when you need to get information about an AI conversation in a user workspace.

• Get User Workspace Flowpipe Mod

  Tool to retrieve details of an installed flowpipe mod in a user workspace. Use when you need information about a specific flowpipe mod installed in a workspace.

• Get User Workspace Integration

  Tool to get details of an integration available for a workspace belonging to a user. Use when you need to retrieve information about a specific integration configured for a user's workspace.

• Get User Workspace Notifier

  Tool to retrieve a notifier from a user workspace. Use when you need to get details about a specific notification endpoint configured for a user's workspace.

• Get User Workspace Process

  Tool to retrieve process details for a user workspace. Use when you need information about a specific process running in a user's workspace.

• Initiate User Login

  Tool to initiate user login. Use when starting a login flow for a user with their email address.

• Install User Slack Integration

  Tool to install a Slack integration for a user identity. Use when you need to initiate the Slack OAuth flow by redirecting to the Slack authorization URL.

• Install User Workspace Flowpipe Mod

  Tool to install a flowpipe mod to a user's workspace. Use when you need to install a flowpipe mod from a repository path into a specific user workspace.

• List Actor Activity

  Tool to list activities for the authenticated actor. Use when you need detailed activity logs with optional filtering and pagination.

• List actor connections

  Tool to list connections associated with the authenticated actor. Use after confirming authentication to retrieve the actor's connection list.

• List Actor Organizations

  Tool to list organizations associated with the authenticated actor. Use when you have a valid access token.

• List Actor Workspaces

  Tool to list workspaces for the authenticated actor. Use when you need to retrieve all workspaces the actor has access to.

• List Identities

  Tool to list all identities. Use when you need to retrieve identities with optional filtering, sorting, and pagination after authentication.

• List Organization Processes

  Tool to list processes for an organization. Use when you need to retrieve all processes for a specific organization with optional pagination.

• List Organization Service Accounts

  Tool to list service accounts at the organization level. Use when you need to retrieve all service accounts for a specific organization.

• List Organization Usage

  Tool to list all usage metrics for an organization. Use when you need to retrieve usage data for billing, monitoring, or analytics purposes.

• List Organization Workspaces

  Tool to list workspaces for a specific organization. Use when you need to retrieve all workspaces associated with an organization handle.

• List Tenants

  Tool to list tenants the actor is a member of. Use when you need to retrieve all tenants associated with the authenticated user.

• List User Audit Logs

  Tool to list audit logs for a specific user. Use when you need to retrieve audit trail information with optional pagination.

• List User Connections

  Tool to list connections for a specific user by user handle. Use when you need to retrieve all connections associated with a user.

• List User Constraints

  Tool to list all applicable constraints for a user. Use when you need to retrieve quota, rate, or setting constraints with optional filtering and pagination.

• List User Emails

  Tool to list emails for a user along with metadata information for each item. Use when you need to retrieve all email addresses associated with a specific user.

• List User Integrations

  Tool to list integrations configured for a user. Use when you need to retrieve all integrations for a specific user with optional pagination.

• List User Notifiers

  Tool to list all notifiers for a user. Use when you need to view a user's configured notification endpoints.

• List User Processes

  Tool to list processes for a user. Use when you need to retrieve all processes for a specific user with optional pagination.

• List User Usage

  Tool to list all usage metrics for a user. Use when you need to retrieve usage data for billing, monitoring, or analytics purposes.

• List User Workspace Aggregator Connections

  Tool to list all connections that are part of an aggregator in a user workspace. Use when you need to retrieve connections within a specific aggregator.

• List User Workspace Audit Logs

  Tool to list audit logs for a specific user workspace. Use when you need to retrieve workspace audit trail information with optional pagination.

• List User Workspace Connection Associations

  Tool to list connections associated with a workspace for a specific user. Use when you need to retrieve all connection associations for a user's workspace.

• List User Workspace Connection Folders

  Tool to list connection folders for a user workspace. Use when you need to retrieve all connection folders associated with a user's workspace.

• List User Workspace Connections

  Tool to list connections explicitly defined or associated to a workspace. Use when you need to retrieve all connections available in a user's workspace.

• List User Workspace Conversations

  Tool to list AI conversations in a user workspace with optional filtering and pagination. Use when you need to retrieve conversations from a specific user workspace, optionally filtered by title pattern.

• List User Workspace Integrations

  Tool to list integrations available for a user workspace. Use when you need to retrieve all integrations configured for a specific user workspace. If run on a custom tenant, this will return integrations configured both on tenant and user level.

• List User Workspace Notifiers

  Tool to list all notifiers for a user workspace. Use when you need to view notification endpoints configured for a specific user's workspace with optional pagination and filtering.

• List User Workspace Snapshots

  Tool to list workspace snapshots for a user. Use when you need to retrieve snapshots from a specific user workspace with optional pagination.

• List User Workspace Usage

  Tool to list the usage associated with a user workspace. Use when you need to retrieve usage metrics for a specific user's workspace with optional filtering and pagination.

• List User Workspaces

  Tool to list workspaces for a specific user. Use when you need to retrieve all workspaces associated with a user handle.

• Run Organization Workspace Command

  Tool to run a command in an organization workspace. Use when you need to execute workspace operations like rebooting a workspace.

• Run User Workspace Command

  Tool to run a command in a user workspace. Use when you need to execute workspace operations like rebooting a user's workspace.

• Run User Workspace Flowpipe Pipeline Command

  Tool to run a command on a Flowpipe pipeline in a user workspace. Use when you need to execute a pipeline command such as 'run' to start pipeline execution.

• Send Chat Message to User Workspace AI

  Tool to send a chat message to the AI agent in a user workspace. Creates a new conversation if conversation_id is not provided, or continues an existing conversation if provided.

• Start login via Email

  Tool to start login process by sending a confirmation code to a user's email. Use when initiating a passwordless email login flow.

• Test User Integration

  Tool to test the config for a user integration to check for basic connectivity before you create it. Use when you need to validate integration credentials and configuration by providing the user handle, integration handle (or _ for new integrations), integration type, and config.

• Test User Workspace Connection

  Tool to test the config for a connection configured on a user workspace to check for basic connectivity. Use when you need to verify that a connection is properly configured before creating or using it.

• Uninstall Flowpipe Mod

  Tool to uninstall a flowpipe mod from a user's workspace. Use when you need to remove a flowpipe mod from a specific workspace after confirming the user handle, workspace handle, and mod alias.

• Uninstall Org Workspace Flowpipe Mod

  Tool to uninstall a flowpipe mod from an organization workspace. Use when you need to remove a flowpipe mod from a specific workspace after confirming org handle, workspace handle, and mod alias.

• Update Org Billing Subscription

  Tool to update an organization billing subscription. Use to stop cancellation at the next billing period by passing 'stopcancel' action or to upgrade the subscription. Useful when managing org subscription lifecycle.

• Update Org Connection

  Tool to update the details of a connection belonging to an organization. Use when you need to modify connection configuration, change config/credential sources, rename the connection handle, or reassign the connection to a different parent entity.

• Update Org Connection Folder

  Tool to update the details of an org connection folder. Use when you need to modify the title or parent location of a connection folder.

• Update Organization Member Role

  Tool to update the role of an organization member. Use when you need to change a member's role (e.g., promote to owner or demote to member) within an organization.

• Update Organization Service Account

  Tool to update an existing service account at the organization level. Use when you need to modify the title, description, or token_min_issued_at for a service account.

• Update Organization Service Account Token

  Tool to update an existing token for an organization-level service account. Use when you need to modify token properties such as status, title, or description.

• Update User

  Tool to update user information including handle name, display name, or URL. Use when you need to modify user attributes.

• Update User Connection

  Tool to update the details of a connection belonging to a user. Use when you need to modify configuration, handle, parent_id, config_source, or credential_source of a user's connection. Requires user_handle and connection_handle to identify the target connection.

• Update User Integration

  Tool to update details of an integration configured for a user. Use when you need to modify an existing user integration's state, handle, or configuration.

• Update User Preferences

  Tool to update user preferences for email communications. Use when you need to change a user's communication preferences such as opting in or out of product updates, community updates, or tips and tricks emails.

• Update User Token

  Tool to update a user token's status between active and inactive. Use when you need to enable or disable a token without deleting it.

• Update User Workspace Conversation

  Tool to update a user workspace conversation (e.g., title). Use when you need to modify properties of an AI conversation in a user workspace.

• Create Org Workspace Query

  Tool to execute a SQL query in an org workspace using POST method. Use when you need to run queries against Turbot Pipes workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

• Create Org Workspace Snapshot

  Tool to create a new workspace snapshot for an organization. Use when you need to save a point-in-time capture of dashboard data, layouts, and panels for a workspace.

• Delete User Integration

  Tool to delete an integration configured for a user. Use when you need to remove a user's integration by providing the user handle and integration handle.

• Get Datatank Table

  Tool to get the details for a workspace Datatank table. Use when you need to retrieve information about a specific datatank table including its state, configuration, and metadata.

• Get Org Connection Permission

  Tool to retrieve permission details for an org connection. Use when you need to view a specific permission record for a connection within an organization.

• Get Org Workspace Connection

  Tool to get the details for a workspace and connection association on an organization. Use when you need to retrieve information about how a connection is associated with a specific workspace in an organization.

• Get Org Workspace Connection Folder

  Tool to retrieve a connection folder for an organization workspace. Use when you need to get details about a specific connection folder in an org workspace.

• Get Org Workspace Flowpipe Trigger

  Tool to get the details of a trigger for a workspace in an organization. Use when you need to retrieve information about a specific Flowpipe trigger.

• Get Org Workspace Mod Variable Setting

  Tool to get setting for a mod variable in an organization workspace. Use when you need to retrieve the current configuration and value of a specific mod variable in a workspace.

• Get Org Workspace Query Data

  Tool to execute a SQL query in an org workspace and retrieve results. Use when you need to run queries against Turbot Pipes workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

• Get Organization Billing Invoice

  Tool to get an invoice for an organization. Use when you need to retrieve detailed billing invoice information for a specific organization and invoice ID.

• Get Organization Member

  Tool to retrieve a specific organization member by org handle and user handle. Use when you need details about a specific member of an organization.

• Get Tenant Avatar

  Tool to retrieve public avatar image for a tenant. Use when you need to display or download the tenant's avatar.

• Get User AI Key

  Tool to retrieve AI provider API key metadata at the user level. Use when you need to check which AI provider keys are configured for a specific user.

• Get User Billing Plan

  Tool to get the current user billing plan. Use when you need to retrieve detailed billing plan information for a specific user.

• Get User Billing Upcoming Invoice

  Tool to get the upcoming invoice for a user. Use when you need to retrieve the estimated next invoice for a user's billing cycle. Returns null when no upcoming invoice exists.

• Get User Workspace

  Tool to retrieve workspace details for a specific user. Use when you need information about a workspace owned by a user.

• Get User Workspace Connection

  Tool to get the details for a workspace and connection association for a user. Use when you need to retrieve information about how a connection is associated with a specific workspace owned by a user.

• Get User Workspace Connection Folder

  Tool to retrieve a connection folder for a user workspace. Use when you need to get details about a specific connection folder in a user workspace.

• Get User Workspace Datatank

  Tool to retrieve user workspace datatank details. Use when you need information about a specific datatank within a user's workspace.

• Get User Workspace Flowpipe Pipeline

  Tool to retrieve pipeline details for a user workspace. Use when you need detailed information about a specific Flowpipe pipeline in a user's workspace.

• Get User Workspace Mod

  Tool to retrieve details of an installed mod in a user's workspace. Use when you need information about a specific mod installed in a workspace owned by a user.

• Get User Workspace Mod Variable Setting

  Tool to get setting for a mod variable in a user workspace. Use when you need to retrieve the current configuration and value of a specific mod variable in a user's workspace.

• Get User Workspace Pipeline

  Tool to get the details of a pipeline for a workspace of a user. Use when you need information about a specific pipeline in a user workspace.

• Get User Workspace Process Log

  Tool to retrieve process logs for a user workspace process. Use when you need to fetch and analyze logs for a specific process running in a user's workspace.

• Get User Workspace Query

  Tool to execute a SQL query in a user workspace and retrieve results. Use when you need to run queries against Turbot Pipes user workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

• Get User Workspace Query Data

  Tool to execute a SQL query in a user workspace and retrieve results. Use when you need to run queries against Turbot Pipes user workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

• Get User Workspace Schema

  Tool to retrieve workspace schema details for a specific user. Use when you need information about a specific schema within a user's workspace.

• Get User Workspace Schema Table

  Tool to get details about a specific table in a user workspace schema. Use when you need information about table structure, columns, and metadata within a user's workspace schema.

• Install User Workspace Mod

  Tool to install a mod to a user workspace. Use when you need to add a new mod from a repository path to a specific workspace.

• List Org Workspace Datatank

  Tool to list org workspace Datatank with pagination support. Use when you need to retrieve Datatank items for a specific organization and workspace.

• List Org Workspace Mods

  Tool to list organization workspace installed mods with pagination support. Use when you need to retrieve installed mods for a specific organization and workspace.

• List Org Workspace Processes

  Tool to list processes associated with an org workspace. Use when you need to retrieve all processes for a specific organization workspace with optional filtering and pagination.

• List Organization Workspace Flowpipe Mod Variables

  Tool to list all variables for a flowpipe mod in an organization workspace. Use when you need to retrieve mod variables within a specific workspace.

• List Organization Workspace Pipelines

  Tool to list pipelines for a workspace of an organization. Use when you need to retrieve scheduled tasks for dashboard snapshots or queries within a specific workspace.

• List User AI Keys

  Tool to list AI provider API keys configured at the user level. Use when you need to retrieve all AI keys for a specific user.

• List User Billing Invoices

  Tool to list user invoices with pagination support. Use when you need to retrieve billing invoice information for a specific user.

• List User Billing Payment Methods

  Tool to list user billing payment methods. Use when you need to retrieve payment methods configured for a user's billing.

• List User Billing Subscriptions

  Tool to list user billing subscriptions. Use when you need to retrieve subscription information for a specific user. Note: Users typically have one active subscription, but this endpoint may also return historical subscriptions.

• List User Workspace Aggregators

  Tool to list aggregators for a workspace of a user. Use when you need to retrieve aggregator configurations for a specific user's workspace.

• List User Workspace Connection Tree

  Tool to list connection tree for a user workspace. Use when you need to retrieve the hierarchical connection structure for a specific user's workspace.

• List User Workspace Database Logs

  Tool to list database query logs for a specific user workspace. Use when you need to retrieve workspace database query history with optional pagination.

• List User Workspace Datatank

  Tool to list user workspace Datatank with pagination support. Use when you need to retrieve Datatank items for a specific user and workspace.

• List User Workspace Datatank Partitions

  Tool to list user workspace Datatank partitions with pagination support. Use when you need to retrieve partition details for a specific Datatank table in a user's workspace.

• List User Workspace Datatank Table

  Tool to list user workspace Datatank tables with pagination support. Use when you need to retrieve datatank tables for a specific user, workspace, and datatank.

• List User Workspace Flowpipe Inputs

  Tool to list Flowpipe inputs for a user workspace. Use when you need to retrieve all Flowpipe inputs for a specific workspace with optional pagination.

• List User Workspace Flowpipe Mod Variables

  Tool to list all variables for a flowpipe mod in a user workspace. Use when you need to retrieve mod variables within a specific workspace owned by a user.

• List User Workspace Flowpipe Pipelines

  Tool to list Flowpipe pipelines for a user workspace. Use when you need to retrieve pipelines within a specific workspace belonging to a user.

• List User Workspace Flowpipe Triggers

  Tool to list Flowpipe triggers for a user workspace. Use when you need to retrieve all triggers configured in a specific user's workspace.

• List User Workspace Mod Variables

  Tool to list all variables applicable for a mod in a workspace specific to a user. Use when you need to retrieve mod variables within a specific user's workspace.

• List User Workspace Mods

  Tool to list user workspace installed mods with pagination support. Use when you need to retrieve installed mods for a specific user and workspace.

• List User Workspace Pipeline Triggers

  Tool to list Flowpipe triggers associated with a specific pipeline in a user workspace. Use when you need to retrieve all triggers configured for a particular pipeline.

• List User Workspace Pipelines

  Tool to list pipelines for a workspace of a user. Use when you need to retrieve scheduled tasks for dashboard snapshots or queries within a specific user workspace.

• List User Workspace Processes

  Tool to list processes associated with a user workspace. Use when you need to retrieve all processes for a specific user workspace with optional filtering and pagination.

• List User Workspace Schema Tables

  Tool to list tables for a user workspace schema with pagination support. Use when you need to retrieve tables for a specific user, workspace, and schema.

• List User Workspace Schemas

  Tool to list schemas for a user workspace. Use when you need to retrieve schemas including aggregators, datatanks, and identity-level connections for a specific user's workspace.

• Post User Workspace Notifier Command

  Tool to post a command for a notifier in a user's workspace. Use when you need to execute commands on workspace notifiers, such as setting a notifier as the default.

• Post User Workspace Query

  Tool to perform a SQL query in a user workspace. Use when you need to execute queries against Turbot Pipes user workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

• Run User Workspace Flowpipe Trigger Command

  Tool to run a command on a trigger in a workspace belonging to a user. Use when you need to execute or reset a Flowpipe trigger.

• Run User Workspace Query

  Tool to perform a SQL query in a user workspace using POST method. Use when you need to execute queries against Turbot Pipes user workspaces. Results are limited to 5000 rows or 30 seconds of execution time.

• Test User AI Key

  Tool to test whether an AI provider API key is valid at the user level. Use when you need to verify if a saved or provided API key works correctly with the specified provider.

• Test User Connection

  Tool to test a user connection for basic connectivity. Use when you need to verify if a connection's configuration is valid and the credentials work correctly with the specified plugin.

• Update User AI Key

  Tool to update an existing AI provider API key at the user level. Use when you need to update an API key for a specific AI provider (OpenAI or Anthropic) for a user.

• Update User Workspace

  Tool to update the workspace for a user. Use when you need to modify workspace settings such as desired state, instance type, database volume size, or search path prefix.