Amazon Redshift
Let agents query your Amazon Redshift warehouse through the Redshift Data API.
Connect it with: API key. Amazon Redshift's own documentation: https://docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusters.html.
What agents can do
Connect Amazon Redshift so the agents working your tasks can reach it. With it connected, they can:
- Run SQL through the Redshift Data API to answer data questions, with no database driver or open port.
- List schemas, tables and columns before writing a query or a migration.
- Read a statement's status and error when a load or transformation fails.
- Check that a nightly load wrote today's rows.
Before you start
- An Amazon Redshift provisioned cluster or a Redshift Serverless workgroup.
- An IAM user for agents with redshift:DescribeClusters (the Test needs it), the Data API actions (redshift-data:ExecuteStatement, DescribeStatement, GetStatementResult) and a way to sign in to the database: redshift:GetClusterCredentialsWithIAM for a cluster or redshift-serverless:GetCredentials for Serverless. The AWS managed policy AmazonRedshiftDataFullAccess covers the Data API.
- A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.
Connect with Amazon Redshift
Jaah connects to Amazon Redshift with an API key, not with a sign-in button.
Connect with an API key
Find each value first:
- Access key ID: AWS console > IAM > Users > the agents' user > Security credentials > Access keys > Create access key; choose Application running outside AWS and copy the Access key ID.
- Secret access key: Shown once, beside the access key ID, when the key is created; download the .csv if you need to keep it.
- Region (optional): The region of your cluster or Serverless workgroup (Redshift console > the region picker at the top right).
- Cluster or workgroup (optional): A provisioned cluster's identifier (Redshift console > Clusters) or a Serverless workgroup's name (Serverless dashboard > Workgroup configuration).
- Database (optional): The database agents query; dev is Redshift's default.
Then add it to Jaah:
- In Jaah, open Secrets, select New, and pick the Amazon Redshift card.
- Name the secret and choose who can use it.
- Fill in Access key ID, Secret access key, Region, Cluster or workgroup, Database.
- Select Save. Jaah tests the secret straight away (see Test the connection).
Jaah encrypts what you type and never shows it again — not to you, and not to an admin.
Use your own OAuth app
Not used: Jaah connects to Amazon Redshift with an API key, not through an OAuth app.
Test the connection
Select Test on the secret. Jaah calls Amazon Redshift's API once (GET https://redshift.us-east-1.amazonaws.com/?Action=DescribeClusters&Version=2012-12-01&MaxRecords=20) with the stored values, and shows whether Amazon Redshift accepted it, or which value Amazon Redshift refused and the status it answered. Jaah also tests automatically when you save or reconnect.
The last result and its time stay on the secret's page, so you can see whether it still works without testing again.
Who can use it
Every secret has an owner, and the owner decides who can use it:
- Personal — only your own tasks can use it. This is the default.
- Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
- Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.
More on owners and access: How secrets work.
Use it in an agent session
An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:
org/<name>for an organization secret,projects/<project>/<name>for one attached to a project,me/<name>for your personal one.
A key connection hands the agent its fields: access_key_id, secret_access_key, region, cluster_or_workgroup, database.
Tell the agent in your task description which secret to use, for example “use the Amazon Redshift secret org/amazon-redshift”.
Manage, rotate or disconnect
Everything is on the secret's page under Secrets:
- Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at Amazon Redshift once the test passes. Steps: Replace or delete a secret.
- Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Amazon Redshift's side too, revoke or delete the key at Amazon Redshift.
Limitations
- Jaah tests by listing clusters in us-east-1 (DescribeClusters). It proves the key and that permission, not access to a database. An account with only Serverless still passes: the list is just empty.
- Only long-lived IAM access keys are supported, not temporary (STS) credentials, and not a database user name and password.
- Agents reach Redshift through the Data API, so queries return at most 100 MB of results each.
- Agents can do only what the connected Amazon Redshift account allows.
Troubleshooting
Test says Amazon Redshift rejected the secret access key (403)
Either the key pair is wrong or deactivated (check it in IAM and create a new one if needed), or the user lacks redshift:DescribeClusters. Add it to the user's policy.
Test passes but queries fail with 'not authorized to get credentials'
Allow redshift:GetClusterCredentialsWithIAM (provisioned) or redshift-serverless:GetCredentials (Serverless) on the user.
Queries fail with 'Cluster not found' or 'workgroup not found'
Set Region to the cluster's region and Cluster or workgroup to its exact identifier.
Still stuck? Select Test and read the result: it names the value Amazon Redshift refused and the status it answered.
FAQ
Do I need to open my cluster to the internet?
No. The Data API is an AWS endpoint, so the cluster can stay private.
Which database user do queries run as?
With IAM credentials, a database user named after the IAM user (IAM:USER_NAME). Grant that user only the tables agents need.
Can Jaah or an admin see the key or token?
No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.
Can I connect more than one Amazon Redshift account?
Yes. Add one secret per account, each with its own name, and tell the agent which one to use.