The Turbot Pipes connector lets your AI agent act in each user's Turbot Pipes account. Each user connects their own Turbot Pipes access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 36 · 16 · 836 read16 write8 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Turbot Pipes connection
In AgentKit > Connections, create a Turbot Pipes connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'turbotpipes'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Turbot Pipes:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'turbotpipes_actor_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "turbotpipes"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Turbot Pipes:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="turbotpipes_actor_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Turbot Pipes credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolturbotpipes_actor_getGet the Turbot Pipes user the API token belongs to.Read-onlyGet Current Actor
Get the Turbot Pipes user the API token belongs to. Returns the user's ID, handle, display name, email and status. Use this to find your user handle for the identity_handle input.
Inputs
This tool takes no inputs.
turbotpipes_actor_orgs_listList the Turbot Pipes organizations the token's user belongs to.Read-onlyList My Orgs
List the Turbot Pipes organizations the token's user belongs to. Returns org memberships with the org handle, display name and your role, plus next_token for paging. Use this to find org handles for the identity_handle input.
Inputs
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_actor_workspaces_listList every Turbot Pipes workspace the token's user can access, across the user and all their orgs.Read-onlyList My Workspaces
List every Turbot Pipes workspace the token's user can access, across the user and all their orgs. Returns workspaces with handle, owner identity, state and database details, plus next_token for paging. Use this to find a workspace across identities. Use turbotpipes_workspaces_list for one identity's workspaces.
Inputs
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_audit_log_listList the audit log of a Turbot Pipes user or org.Read-onlyList Audit Logs
List the audit log of a Turbot Pipes user or org. Returns audit entries with action type, actor, target, data and time, plus next_token for paging. Use this for who-did-what across an identity. Use turbotpipes_workspace_audit_log_list for one workspace.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_connection_getGet one connection of a Turbot Pipes user or org.Read-onlyGet Connection
Get one connection of a Turbot Pipes user or org. Returns the connection with handle, plugin, config (secrets masked) and timestamps. Use this for a connection's details.
Inputs
connection_handlestringrequired- The handle of the connection whose detail needs to be fetched. Example: aws_prod.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg
turbotpipes_connection_testTest a plugin config for a Turbot Pipes user or org connection for basic connectivity, before you create or update the connection.Read-onlyTest Connection
Test a plugin config for a Turbot Pipes user or org connection for basic connectivity, before you create or update the connection. Returns the test result with state and any error. Use this to check credentials. Use turbotpipes_connection_create to save the connection.
Inputs
connection_handlestringrequired- The handle of the connection to be tested. For connections that are not yet created, use underscore _ as the handle, else pass the handle of the existing connection. Example: aws_prod.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pluginstringrequired- Steampipe plugin name, such as aws or github. Example: aws.
configobject- Plugin configuration to test, as a JSON object. Example: {"regions": ["us-east-1"], "access_key": "AKIAEXAMPLE", "secret_key": "example-secret"}
turbotpipes_connections_listList the connections (plugin credentials) of a Turbot Pipes user or org.Read-onlyList Connections
List the connections (plugin credentials) of a Turbot Pipes user or org. Returns connections with handle, plugin, type and timestamps, plus next_token for paging. Use this for identity-level connections. Use turbotpipes_workspace_connections_list for a workspace's connections.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_identities_searchSearch Turbot Pipes identities (users and orgs) by text.Read-onlySearch Identities
Search Turbot Pipes identities (users and orgs) by text. Returns matching identities with handle, type and display name. Use this to look up a user or org handle.
Inputs
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
qstring- Optional free-text search to filter the identities. Example: acme.
turbotpipes_integrations_listList the integrations (GitHub, GitLab, Slack and others) of a Turbot Pipes user or org.Read-onlyList Integrations
List the integrations (GitHub, GitLab, Slack and others) of a Turbot Pipes user or org. Returns integrations with handle, type, state and timestamps, plus next_token for paging. Use this to find an integration handle, for example for private mod repositories.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_org_members_listList the members of a Turbot Pipes organization.Read-onlyList Org Members
List the members of a Turbot Pipes organization. Returns members with user handle, display name, email, role and status, plus next_token for paging. Use this to see who is in an org. Use turbotpipes_org_workspace_members_list for one workspace.
Inputs
org_handlestringrequired- Specify the organization handle. Example: acme.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
qstring- Optional free-text search to filter the org members. Example: acme.
turbotpipes_org_workspace_members_listList the members of a workspace that belongs to a Turbot Pipes organization.Read-onlyList Org Workspace Members
List the members of a workspace that belongs to a Turbot Pipes organization. Returns members with user handle, role and status, plus next_token for paging. Use this to see who can access an org workspace.
Inputs
org_handlestringrequired- Specify the handle of the organization where the member need to be invited. Example: acme.
workspace_handlestringrequired- Specify the handle of the workspace where the member need to be invited. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
qstring- Optional free-text search to filter the org workspace members. Example: acme.
turbotpipes_usage_listList the metered usage of a Turbot Pipes user or org.Read-onlyList Usage
List the metered usage of a Turbot Pipes user or org. Returns usage records with type, workspace, amount and time, plus next_token for paging. Use this to check consumption by workspace.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
wherestring- 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. Example: state = 'finished'.
turbotpipes_workspace_audit_log_listList the audit log of a Turbot Pipes workspace.Read-onlyList Workspace Audit Logs
List the audit log of a Turbot Pipes workspace. Returns audit entries with action type, actor, target, data and time, plus next_token for paging. Use this for changes in one workspace.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace whose logs needs to be fetched. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_workspace_connection_getGet one connection association of a Turbot Pipes workspace.Read-onlyGet Workspace Connection
Get one connection association of a Turbot Pipes workspace. Returns the association with the connection details. Use this for a workspace connection's details.
Inputs
connection_handlestringrequired- The handle of the connection whose association details needs to be fetched. Example: aws_prod.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace where the connection exist. Example: dev.
turbotpipes_workspace_connections_listList the connections associated with a Turbot Pipes workspace.Read-onlyList Workspace Connections
List the connections associated with a Turbot Pipes workspace. Returns the associations with the connection handle, plugin and workspace, plus next_token for paging. Use this to see which connections a workspace uses.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace where you want to list the associations. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_workspace_datatank_getGet one Datatank of a Turbot Pipes workspace.Read-onlyGet Workspace Datatank
Get one Datatank of a Turbot Pipes workspace. Returns the Datatank with handle, description, state and timestamps. Use this for a Datatank's details.
Inputs
datatank_handlestringrequired- The name of the workspace Datatank. Example: aws_cache.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace. Example: dev.
turbotpipes_workspace_datatank_tables_listList the tables of a Turbot Pipes workspace Datatank.Read-onlyList Workspace Datatank Tables
List the tables of a Turbot Pipes workspace Datatank. Returns tables with name, type, source query, frequency, state and last update. Use this to see what a Datatank stores.
Inputs
datatank_handlestringrequired- The name of the Datatank. Example: aws_cache.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_workspace_datatanks_listList the Datatanks of a Turbot Pipes workspace; a Datatank stores query results as tables for faster queries.Read-onlyList Workspace Datatanks
List the Datatanks of a Turbot Pipes workspace; a Datatank stores query results as tables for faster queries. Returns Datatanks with handle, description, state and timestamps, plus next_token for paging. Use this to find Datatanks. Use turbotpipes_workspace_datatank_tables_list for their tables.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_workspace_flowpipe_pipeline_getGet one Flowpipe pipeline of a Turbot Pipes workspace.Read-onlyGet Flowpipe Pipeline
Get one Flowpipe pipeline of a Turbot Pipes workspace. Returns the pipeline with name, title, description, parameters and mod. Use this to see a pipeline's parameters before running it.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pipeline_idstringrequired- The id of the pipeline whose detail needs to be fetched. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
workspace_handlestringrequired- The handle of the workspace where the pipeline exists. Example: dev.
turbotpipes_workspace_flowpipe_pipelines_listList the Flowpipe pipelines available in a Turbot Pipes workspace from its installed Flowpipe mods.Read-onlyList Flowpipe Pipelines
List the Flowpipe pipelines available in a Turbot Pipes workspace from its installed Flowpipe mods. Returns pipelines with ID, name, title, description and parameters, plus next_token for paging. Use this to find a Flowpipe pipeline to run with turbotpipes_workspace_flowpipe_pipeline_run.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace for which we want to list the pipelines. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
wherestring- 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. Example: state = 'finished'.
turbotpipes_workspace_getGet one Turbot Pipes workspace.Read-onlyGet Workspace
Get one Turbot Pipes workspace. Returns the workspace with handle, state, instance type, database name and host, search path and timestamps. Use this for a workspace's details. Use turbotpipes_workspace_query to run SQL in it.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace whose detail needs to be fetched. Example: dev.
turbotpipes_workspace_mod_getGet one mod installed in a Turbot Pipes workspace.Read-onlyGet Workspace Mod
Get one mod installed in a Turbot Pipes workspace. Returns the mod with alias, path, constraint, installed version and state. Use this for a mod's details. Use turbotpipes_workspace_mod_variables_list for its variables.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg mod_aliasstringrequired- The mod alias or mod ID. Example: aws_compliance.
workspace_handlestringrequired- The handle of the workspace where mod was installed. Example: dev.
turbotpipes_workspace_mod_variables_listList the variables of a mod in a Turbot Pipes workspace, with their defaults and settings.Read-onlyList Workspace Mod Variables
List the variables of a mod in a Turbot Pipes workspace, with their defaults and settings. Returns variables with name, type, description, default and the workspace setting. Use this before setting a variable with turbotpipes_workspace_mod_variable_set.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg mod_aliasstringrequired- The mod alias or mod ID for which we want the variables to be listed. Example: aws_compliance.
workspace_handlestringrequired- The handle of the workspace where the mod was installed. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_workspace_mods_listList the Powerpipe mods installed in a Turbot Pipes workspace.Read-onlyList Workspace Mods
List the Powerpipe mods installed in a Turbot Pipes workspace. Returns mods with alias, path, version constraint, installed version and state. Use this to see installed mods. Use turbotpipes_workspace_mod_install to add one.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace where mods were installed. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_workspace_pipeline_getGet one scheduled pipeline of a Turbot Pipes workspace.Read-onlyGet Workspace Pipeline
Get one scheduled pipeline of a Turbot Pipes workspace. Returns the pipeline with title, type, args, frequency, state and last process. Use this for a pipeline's details.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pipeline_idstringrequired- The id of the pipeline whose detail needs to be fetched. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
workspace_handlestringrequired- The handle of the workspace where the pipeline exists. Example: dev.
turbotpipes_workspace_pipelines_listList the scheduled pipelines of a Turbot Pipes workspace, such as dashboard and query snapshot schedules.Read-onlyList Workspace Pipelines
List the scheduled pipelines of a Turbot Pipes workspace, such as dashboard and query snapshot schedules. Returns pipelines with ID, title, pipeline type, frequency, state and last process, plus next_token for paging. Use this to see scheduled jobs. Use turbotpipes_workspace_pipeline_get for one pipeline.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace for which we want to list the pipelines. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
wherestring- 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. Example: state = 'finished'.
turbotpipes_workspace_process_getGet one process of a Turbot Pipes workspace.Read-onlyGet Workspace Process
Get one process of a Turbot Pipes workspace. Returns the process with type, state, pipeline and timestamps. Use this to check whether a run or command finished.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg process_idstringrequired- The id of the process to be fetched. Example: p_cg7l1m5d4cq1rr6j1fi0.
workspace_handlestringrequired- The handle of the workspace whose process needs to be fetched. Example: dev.
turbotpipes_workspace_processes_listList the processes (pipeline runs, mod installs, workspace commands) of a Turbot Pipes workspace.Read-onlyList Workspace Processes
List the processes (pipeline runs, mod installs, workspace commands) of a Turbot Pipes workspace. Returns processes with ID, type, state, pipeline and timestamps, plus next_token for paging. Use this to check recent jobs. Filter with where, such as state = 'failed'.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace where you want to list the processes. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
wherestring- 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. Example: state = 'finished'.
turbotpipes_workspace_queryRun a SQL query against a Turbot Pipes workspace's Steampipe database, up to 5,000 rows or 30 seconds.Read-onlyQuery Workspace
Run a SQL query against a Turbot Pipes workspace's Steampipe database, up to 5,000 rows or 30 seconds. Returns the columns and rows of the result. Use this to query cloud and SaaS data through the workspace's connections. Use turbotpipes_workspace_schema_tables_list to find tables.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg sqlstringrequired- The sql query to perform against the workspace. Example: select name, region from aws_s3_bucket limit 10.
workspace_handlestringrequired- The handle of the workspace to query. Example: dev.
turbotpipes_workspace_schema_getGet one schema attached to a Turbot Pipes workspace.Read-onlyGet Workspace Schema
Get one schema attached to a Turbot Pipes workspace. Returns the schema with name, type and its connection or aggregator. Use this for a schema's details. Use turbotpipes_workspace_schema_tables_list for its tables.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg schema_namestringrequired- The name of the schema whose detail needs to be fetched. Example: aws_prod.
workspace_handlestringrequired- The handle of the workspace where the schema exists. Example: dev.
turbotpipes_workspace_schema_table_getGet one table in a schema of a Turbot Pipes workspace.Read-onlyGet Workspace Schema Table
Get one table in a schema of a Turbot Pipes workspace. Returns the table with its description and columns (name, type, description). Use this to see a table's columns before writing a query.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg schema_namestringrequired- The name of the schema to which the table belongs. Example: aws_prod.
table_namestringrequired- The name of the table whose detail needs to be fetched. Example: aws_s3_bucket.
workspace_handlestringrequired- The handle of the workspace where the schema exists. Example: dev.
turbotpipes_workspace_schema_tables_listList the tables in a schema of a Turbot Pipes workspace.Read-onlyList Workspace Schema Tables
List the tables in a schema of a Turbot Pipes workspace. Returns tables with name and description. Use this to find tables to query. Use turbotpipes_workspace_schema_table_get for a table's columns.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg schema_namestringrequired- The name of the schema whose detail needs to be fetched. Example: aws_prod.
workspace_handlestringrequired- The handle of the workspace where the schema exists. Example: dev.
turbotpipes_workspace_schemas_listList the schemas attached to a Turbot Pipes workspace, one per connection or aggregator.Read-onlyList Workspace Schemas
List the schemas attached to a Turbot Pipes workspace, one per connection or aggregator. Returns schemas with name, type and the connection or aggregator they come from. Use this to see what data a workspace can query.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace to get the schemas for. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_workspace_snapshot_getGet one snapshot of a Turbot Pipes workspace.Read-onlyGet Workspace Snapshot
Get one snapshot of a Turbot Pipes workspace. Returns the snapshot metadata with title, dashboard, visibility, tags and the user who created it. Use this for a snapshot's details.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg snapshot_idstringrequired- The handle of the snapshot whose detail needs to be fetched. Example: snap_cg7l1m5d4cq1rr6j1fi0_4z9k8ugh8oz0ijexqv1t0xx3o.
workspace_handlestringrequired- The handle of the workspace that the snapshot belongs to. Example: dev.
turbotpipes_workspace_snapshots_listList the dashboard and query snapshots of a Turbot Pipes workspace.Read-onlyList Workspace Snapshots
List the dashboard and query snapshots of a Turbot Pipes workspace. Returns snapshots with ID, title, dashboard name, visibility, tags and timestamps, plus next_token for paging. Use this to find snapshots. Use turbotpipes_workspace_snapshot_get for one snapshot.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace to list snapshots for. Example: dev.
limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
wherestring- 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. Example: state = 'finished'.
turbotpipes_workspaces_listList the workspaces of a Turbot Pipes user or org.Read-onlyList Workspaces
List the workspaces of a Turbot Pipes user or org. Returns workspaces with handle, state, instance type, database host and timestamps, plus next_token for paging. Use this for one identity's workspaces. Use turbotpipes_actor_workspaces_list for all of yours.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg limitinteger- 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. Example: 25.
next_tokenstring- 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
turbotpipes_connection_createCreate a connection (a Steampipe plugin with its config) for a Turbot Pipes user or org.WriteCreate Connection
Create a connection (a Steampipe plugin with its config) for a Turbot Pipes user or org. Returns the new connection. Use this to add credentials for a plugin such as aws or github. Use turbotpipes_workspace_connection_create to create one directly in a workspace.
Inputs
handlestringrequired- Connection handle: lowercase letters, numbers and underscores; it becomes the schema name. Example: aws_prod.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pluginstringrequired- Steampipe plugin name, such as aws, azure, gcp, github or slack. Example: aws.
configobject- Plugin configuration as a JSON object, with the same keys as the plugin's Steampipe connection config. Example: {"regions": ["us-east-1"], "access_key": "AKIAEXAMPLE", "secret_key": "example-secret"}
modestring- The mode of this request. Example: available.one of
available parent_idstring- ID of the connection folder to create it in. Example: cf_cg7l1m5d4cq1rr6j1fi0.
turbotpipes_connection_updateUpdate a connection of a Turbot Pipes user or org: rename it, change its config or move it to a folder.WriteUpdate Connection
Update a connection of a Turbot Pipes user or org: rename it, change its config or move it to a folder. Returns the updated connection. Use this to rotate credentials or change plugin settings.
- Idempotent
Inputs
connection_handlestringrequired- The handle of the connection which needs to be updated. Example: aws_prod.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg configobject- New plugin configuration as a JSON object. Example: {"regions": ["us-east-1", "eu-west-1"]}
handlestring- New connection handle. Example: aws_production.
modestring- The mode of this request. Example: available.one of
available parent_idstring- ID of the connection folder to move it to. Example: cf_cg7l1m5d4cq1rr6j1fi0.
turbotpipes_workspace_commandRun a command on a Turbot Pipes workspace: reboot, stop, start or upgrade its database.WriteRun Workspace Command
Run a command on a Turbot Pipes workspace: reboot, stop, start or upgrade its database. Returns the command and the ID of the process that runs it. Use this to restart or upgrade a workspace. Use turbotpipes_workspace_process_get to follow the process.
Inputs
commandstringrequired- Command to run: reboot, stop, start or upgrade. Example: reboot.one of
rebootstopstartupgrade identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace where command will be executed. Example: dev.
turbotpipes_workspace_connection_createCreate a connection in a Turbot Pipes workspace, or associate the identity's existing connection with the workspace.WriteAdd Workspace Connection
Create a connection in a Turbot Pipes workspace, or associate the identity's existing connection with the workspace. Returns the workspace connection association. Use this to give a workspace access to a plugin. Use turbotpipes_connection_create for an identity-level connection.
Inputs
handlestringrequired- Connection handle; use the handle of an existing identity connection to associate it. Example: aws_prod.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pluginstringrequired- Steampipe plugin name, such as aws or github. Example: aws.
workspace_handlestringrequired- The handle of the workspace where the connection will be created / associated. Example: dev.
configobject- Plugin configuration as a JSON object, for a new connection. Example: {"regions": ["us-east-1"]}
parent_idstring- ID of the connection folder to create it in. Example: cf_cg7l1m5d4cq1rr6j1fi0.
turbotpipes_workspace_createCreate a workspace for a Turbot Pipes user or org (an org can have up to 10).WriteCreate Workspace
Create a workspace for a Turbot Pipes user or org (an org can have up to 10). Returns the new workspace with its handle and state. Use this to add a workspace. Use turbotpipes_workspace_update to change one.
Inputs
handlestringrequired- Workspace handle: lowercase letters, numbers and hyphens, unique for the identity. Example: dev.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg desired_statestring- Desired state: enabled or disabled. Example: enabled.one of
enableddisabled instance_typestring- Database instance size: db1.shared, db1.small or db1.medium. Example: db1.shared.one of
db1.shareddb1.smalldb1.medium
turbotpipes_workspace_flowpipe_pipeline_runRun a Flowpipe pipeline in a Turbot Pipes workspace.WriteRun Flowpipe Pipeline
Run a Flowpipe pipeline in a Turbot Pipes workspace. Returns the command and the ID of the process that runs it. Use this to start an automation. Use turbotpipes_workspace_process_get to follow it.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pipeline_namestringrequired- Identifier of the Flowpipe pipeline on which the command will be run. Example: mod.pipeline.notify_slack.
workspace_handlestringrequired- The handle of the workspace where the Flowpipe pipeline exists. Example: dev.
argsobject- Pipeline parameters as a JSON object. Example: {"message": "Deploy finished"}
turbotpipes_workspace_mod_installInstall a mod, such as a compliance or insights mod, into a Turbot Pipes workspace.WriteInstall Workspace Mod
Install a mod, such as a compliance or insights mod, into a Turbot Pipes workspace. Returns the installed mod with its alias and state. Use this to add dashboards and benchmarks. Use turbotpipes_workspace_mod_update to change its version.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pathstringrequired- Mod repository path. Example: github.com/turbot/steampipe-mod-aws-compliance.
workspace_handlestringrequired- The handle of the workspace where the mod will be installed. Example: dev.
branchstring- Git branch to install from. Example: main.
constraintstring- Version constraint, such as ^1.0 or latest. Example: ^1.0.
integration_handlestring- Handle of a GitHub or GitLab integration, for private mod repositories. Example: github_acme.
versionstring- Exact version to install. Example: 1.2.0.
turbotpipes_workspace_mod_updateChange the version, constraint or branch of a mod in a Turbot Pipes workspace.WriteUpdate Workspace Mod
Change the version, constraint or branch of a mod in a Turbot Pipes workspace. Returns the updated mod. Use this to upgrade or pin a mod.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg mod_aliasstringrequired- The mod alias or mod ID to update. Example: aws_compliance.
workspace_handlestringrequired- The handle of the workspace where the mod will be updated. Example: dev.
branchstring- Git branch. Example: main.
constraintstring- New version constraint. Example: ^2.0.
versionstring- Exact version. Example: 2.0.1.
turbotpipes_workspace_mod_variable_setCreate a setting for a mod variable in a Turbot Pipes workspace.WriteSet Workspace Mod Variable
Create a setting for a mod variable in a Turbot Pipes workspace. Returns the variable with its new setting. Use this for a variable that has no setting yet. Use turbotpipes_workspace_mod_variable_update to change an existing setting.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg mod_aliasstringrequired- The mod alias or mod ID for which the variable setting is to be created. Example: aws_compliance.
namestringrequired- Variable name. Example: common_dimensions.
settingstringrequired- Value for the variable, as JSON text: a string in quotes, a number, a list or an object. Example: ["account_id", "region"]
workspace_handlestringrequired- The handle of the workspace where the mod was installed. Example: dev.
turbotpipes_workspace_mod_variable_updateUpdate the setting of a mod variable in a Turbot Pipes workspace.WriteUpdate Workspace Mod Variable
Update the setting of a mod variable in a Turbot Pipes workspace. Returns the variable with its new setting. Use this to change a variable already set.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg mod_aliasstringrequired- The mod alias or mod ID which contains the variable. Example: aws_compliance.
settingstringrequired- New value for the variable, as JSON text: a string in quotes, a number, a list or an object. Example: ["account_id", "region"]
variable_namestringrequired- The name of the variable for which setting is to be updated. Example: common_dimensions.
workspace_handlestringrequired- The handle of the workspace where the mod was installed. Example: dev.
turbotpipes_workspace_pipeline_createCreate a scheduled pipeline in a Turbot Pipes workspace that snapshots a dashboard or query on an interval, cron schedule or manually.WriteCreate Workspace Pipeline
Create a scheduled pipeline in a Turbot Pipes workspace that snapshots a dashboard or query on an interval, cron schedule or manually. Returns the new pipeline with its ID. Use this to schedule snapshots. Use turbotpipes_workspace_pipeline_run to run it now.
Inputs
argsobjectrequired- Arguments for the pipeline, such as the resource (dashboard name), inputs and snapshot tags. Example: {"resource": "aws_compliance.benchmark.cis_v300", "snapshot_tags": {"source": "pipes"}}
frequencyobjectrequired- When it runs: an object with type (interval, cron or manual) and, for interval or cron, a schedule such as daily or a cron expression. Example: {"type": "interval", "schedule": "daily"}
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pipelinestringrequired- Pipeline to run: pipeline.snapshot_dashboard or pipeline.snapshot_query. Example: pipeline.snapshot_dashboard.one of
pipeline.snapshot_dashboardpipeline.snapshot_query titlestringrequired- Pipeline title. Example: Daily S3 compliance snapshot.
workspace_handlestringrequired- The handle of the workspace where we want to create the pipeline. Example: dev.
desired_statestring- Desired state: enabled or disabled. Example: enabled.one of
enableddisabled tagsobject- Tags as a JSON object. Example: {"team": "security"}
turbotpipes_workspace_pipeline_runRun a scheduled pipeline of a Turbot Pipes workspace now.WriteRun Workspace Pipeline
Run a scheduled pipeline of a Turbot Pipes workspace now. Returns the command and the ID of the process that runs it. Use this to take a snapshot on demand. Use turbotpipes_workspace_process_get to follow the run.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pipeline_idstringrequired- Id of the pipeline on which the command will be run. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
workspace_handlestringrequired- The handle of the workspace where the pipeline exists. Example: dev.
argsobject- Arguments that override the pipeline's own for this run. Example: {}
turbotpipes_workspace_pipeline_updateUpdate a scheduled pipeline in a Turbot Pipes workspace: title, arguments, schedule, state or tags.WriteUpdate Workspace Pipeline
Update a scheduled pipeline in a Turbot Pipes workspace: title, arguments, schedule, state or tags. Returns the updated pipeline. Use this to pause, reschedule or change a pipeline.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pipeline_idstringrequired- The id of the pipeline which needs to be updated. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
workspace_handlestringrequired- The handle of the workspace where the pipeline exists. Example: dev.
argsobject- New pipeline arguments. Example: {"resource": "aws_compliance.benchmark.cis_v300"}
desired_statestring- Desired state: enabled or disabled. Example: enabled.one of
enableddisabled frequencyobject- New schedule: an object with type (interval, cron or manual) and schedule. Example: {"type": "cron", "schedule": "0 6 * * 1"}
tagsobject- Tags as a JSON object. Example: {"team": "security"}
titlestring- New title. Example: Weekly S3 compliance snapshot.
turbotpipes_workspace_schema_attachAttach an identity-level connection, connection folder or aggregator as a schema in a Turbot Pipes workspace.WriteAttach Workspace Schema
Attach an identity-level connection, connection folder or aggregator as a schema in a Turbot Pipes workspace. Returns the attached schema. Use this to make an existing connection queryable in a workspace. Set one of connection_handle, connection_folder or aggregator_handle.
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace where the schema will be attached. Example: dev.
aggregator_handlestring- Handle of an aggregator to attach. Example: aws_all.
connection_folderstring- ID of a connection folder to attach. Example: cf_cg7l1m5d4cq1rr6j1fi0.
connection_handlestring- Handle of the identity's connection to attach. Example: aws_prod.
turbotpipes_workspace_snapshot_updateUpdate the title, tags or visibility of a Turbot Pipes workspace snapshot.WriteUpdate Workspace Snapshot
Update the title, tags or visibility of a Turbot Pipes workspace snapshot. Returns the updated snapshot. Use this to share a snapshot with anyone with the link or rename it.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg snapshot_idstringrequired- The handle of the snapshot to update. Example: snap_cg7l1m5d4cq1rr6j1fi0_4z9k8ugh8oz0ijexqv1t0xx3o.
workspace_handlestringrequired- The handle of the workspace that the snapshot belongs to. Example: dev.
tagsobject- Tags as a JSON object of keys to values. Example: {"team": "security"}
titlestring- New snapshot title. Example: Weekly S3 compliance.
visibilitystring- Who can see it: workspace or anyone_with_link. Example: workspace.one of
workspaceanyone_with_link
turbotpipes_workspace_updateUpdate a Turbot Pipes workspace: rename it, change its instance type, state or search path prefix.WriteUpdate Workspace
Update a Turbot Pipes workspace: rename it, change its instance type, state or search path prefix. Returns the updated workspace. Use this to change workspace settings. Use turbotpipes_workspace_command to reboot or upgrade it.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace which needs to be updated. Example: dev.
desired_statestring- Desired state: enabled or disabled. Example: enabled.one of
enableddisabled handlestring- New workspace handle. Example: dev-2.
instance_typestring- New database instance size: db1.shared, db1.small or db1.medium. Example: db1.small.one of
db1.shareddb1.smalldb1.medium search_path_prefixarray- Schemas to put first in the Steampipe search path. Example: ["aws_prod", "aws_dev"]
turbotpipes_connection_deleteDelete a connection of a Turbot Pipes user or org; workspaces that use it lose its schema.DestructiveDelete Connection
Delete a connection of a Turbot Pipes user or org; workspaces that use it lose its schema. Returns the deleted connection. Use this to remove credentials for good.
- Idempotent
Inputs
connection_handlestringrequired- The handle of the connection that needs to be deleted. Example: aws_prod.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg
turbotpipes_workspace_connection_deleteRemove a connection from a Turbot Pipes workspace.DestructiveRemove Workspace Connection
Remove a connection from a Turbot Pipes workspace. Returns the removed association. Use this to stop a workspace from using a connection.
- Idempotent
Inputs
connection_handlestringrequired- The handle of the connection whose association needs to be deleted. Example: aws_prod.
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- The handle of the workspace whose association needs to be deleted. Example: dev.
turbotpipes_workspace_deleteDelete a Turbot Pipes workspace and its database.DestructiveDelete Workspace
Delete a Turbot Pipes workspace and its database. Returns the deleted workspace. Use this only to remove a workspace for good.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg workspace_handlestringrequired- Provide the handle of the workspace which needs to be deleted. Example: dev.
turbotpipes_workspace_mod_uninstallUninstall a mod from a Turbot Pipes workspace.DestructiveUninstall Workspace Mod
Uninstall a mod from a Turbot Pipes workspace. Returns the removed mod. Use this to remove a mod's dashboards and benchmarks.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg mod_aliasstringrequired- The mod alias or mod ID to delete. Example: aws_compliance.
workspace_handlestringrequired- The handle of the workspace where the mod was installed. Example: dev.
turbotpipes_workspace_mod_variable_deleteDelete the setting of a mod variable in a Turbot Pipes workspace, so the variable uses its default again.DestructiveDelete Workspace Mod Variable
Delete the setting of a mod variable in a Turbot Pipes workspace, so the variable uses its default again. Returns the deleted setting. Use this to reset a variable.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg mod_aliasstringrequired- The mod alias or mod ID which contains the variable. Example: aws_compliance.
variable_namestringrequired- The name of the variable to delete the setting for. Example: common_dimensions.
workspace_handlestringrequired- The handle of the workspace where the mod was installed. Example: dev.
turbotpipes_workspace_pipeline_deleteDelete a scheduled pipeline from a Turbot Pipes workspace.DestructiveDelete Workspace Pipeline
Delete a scheduled pipeline from a Turbot Pipes workspace. Returns the deleted pipeline. Use this to remove a schedule for good. Use turbotpipes_workspace_pipeline_update with desired_state disabled to pause it.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg pipeline_idstringrequired- Provide the id of the pipeline which needs to be deleted. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
workspace_handlestringrequired- The handle of the workspace where the pipeline exists. Example: dev.
turbotpipes_workspace_schema_detachDetach a schema from a Turbot Pipes workspace; the connection itself is kept.DestructiveDetach Workspace Schema
Detach a schema from a Turbot Pipes workspace; the connection itself is kept. Returns the detached schema. Use this to stop a workspace from querying a connection. Use turbotpipes_connection_delete to delete the connection.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg schema_namestringrequired- The name of the schema that will be detached. Example: aws_prod.
workspace_handlestringrequired- The handle of the workspace from which the schema will be detached. Example: dev.
turbotpipes_workspace_snapshot_deleteDelete a snapshot from a Turbot Pipes workspace.DestructiveDelete Workspace Snapshot
Delete a snapshot from a Turbot Pipes workspace. Returns the deleted snapshot. Use this to remove a snapshot for good.
- Idempotent
Inputs
identity_handlestringrequired- Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
identity_typestringrequired- Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org.one of
userorg snapshot_idstringrequired- The handle of the snapshot which needs to be deleted. Example: snap_cg7l1m5d4cq1rr6j1fi0_4z9k8ugh8oz0ijexqv1t0xx3o.
workspace_handlestringrequired- The handle of the workspace that the snapshot belongs to. Example: dev.
No tools match.