AWS Redshift connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. 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>

What you can do

Connect this agent connector to let your agent:

• List tables, statements, schemas — List tables in an Amazon Redshift database using the Redshift Data API
• Get query result — Retrieve the results of a previously executed Redshift SQL statement using the statement ID returned by redshift_execute_sql
• Execute sql — Execute a SQL statement against Amazon Redshift using the Redshift Data API
• Table describe — Describe the schema of a table in Amazon Redshift using the Redshift Data API, including column names, types, and metadata
• Query cancel — Cancel a running Amazon Redshift SQL statement using its statement ID

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

redshift_cancel_query # Cancel a running Amazon Redshift SQL statement using its statement ID. 1 param ▾

Cancel a running Amazon Redshift SQL statement using its statement ID.

Name Type Required Description

statement_id string required The ID of the statement to cancel. Must be non-empty.

redshift_describe_table # Describe the schema of a table in Amazon Redshift using the Redshift Data API, including column names, types, and metadata. 5 params ▾

Describe the schema of a table in Amazon Redshift using the Redshift Data API, including column names, types, and metadata.

Name Type Required Description

table string required Name of the table to describe. Must be non-empty.

connected_database string optional Override the connected account's default database for this request.

max_results integer optional Maximum number of columns to return per page.

next_token string optional Pagination cursor from a previous redshift_describe_table response.

schema string optional Schema name that contains the table.

redshift_execute_sql # Execute a SQL statement against Amazon Redshift using the Redshift Data API. Returns a statement ID that can be used with redshift_get_query_result to fetch results. 3 params ▾

Execute a SQL statement against Amazon Redshift using the Redshift Data API. Returns a statement ID that can be used with redshift_get_query_result to fetch results.

Name Type Required Description

sql string required SQL statement to execute. Must be non-empty.

statement_name string optional Optional label for the statement, echoed back by DescribeStatement for tracking purposes.

with_event boolean optional If true, AWS publishes an EventBridge event when the statement completes.

redshift_get_query_result # Retrieve the results of a previously executed Redshift SQL statement using the statement ID returned by redshift_execute_sql. Supports pagination via next_token. 2 params ▾

Retrieve the results of a previously executed Redshift SQL statement using the statement ID returned by redshift_execute_sql. Supports pagination via next_token.

Name Type Required Description

statement_id string required The statement ID returned by redshift_execute_sql. Must be non-empty.

next_token string optional Pagination token from a prior redshift_get_query_result response when results spanned multiple pages.

redshift_list_schemas # List schemas in an Amazon Redshift database using the Redshift Data API. Supports filtering by schema name pattern with pagination. 4 params ▾

List schemas in an Amazon Redshift database using the Redshift Data API. Supports filtering by schema name pattern with pagination.

Name Type Required Description

connected_database string optional Override the connected account's default database for this request.

max_results integer optional Maximum number of schemas to return.

next_token string optional Pagination cursor from a previous redshift_list_schemas response.

schema_pattern string optional LIKE pattern to filter schemas (e.g., public, my_schema%).

redshift_list_statements # List previously executed SQL statements in Amazon Redshift using the Redshift Data API. Supports filtering by name, status, and role level with pagination. 5 params ▾

List previously executed SQL statements in Amazon Redshift using the Redshift Data API. Supports filtering by name, status, and role level with pagination.

Name Type Required Description

max_results integer optional Maximum number of statements to return.

next_token string optional Pagination cursor from a previous redshift_list_statements response.

role_level boolean optional When true, lists all statements run by the IAM role rather than just the current session.

statement_name string optional Filter statements by name label.

status string optional Filter by execution status (e.g., FINISHED, FAILED, ABORTED, PICKED, STARTED, SUBMITTED).

redshift_list_tables # List tables in an Amazon Redshift database using the Redshift Data API. Supports filtering by schema and table name patterns with pagination. 5 params ▾

List tables in an Amazon Redshift database using the Redshift Data API. Supports filtering by schema and table name patterns with pagination.

Name Type Required Description

connected_database string optional Override the connected account's default database for this request.

max_results integer optional Maximum number of tables to return.

next_token string optional Pagination cursor from a previous redshift_list_tables response.

schema_pattern string optional LIKE pattern to filter schemas (e.g., public, my_schema%).

table_pattern string optional LIKE pattern to filter tables (e.g., orders, user%).