# Redshift Connector
key: aws-redshift[Source](https://github.com/prismatic-io/components/tree/main/components/aws-redshift)[API Docs](https://docs.aws.amazon.com/redshift/latest/APIReference/API_Operations.html)[Connector Changelog](#changelog)
## Description[](#description "Direct link to Description")
[Amazon Redshift](https://aws.amazon.com/redshift/) is a data warehouse service in the cloud to analyze large datasets using standard SQL and existing business intelligence tools. This component allows executing SQL statements and managing data in Amazon Redshift using the AWS Redshift Data API.
#### API Documentation[](#api-documentation "Direct link to API Documentation")
This component was built using the [AWS SDK for JavaScript v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/)
## Connections[](#connections "Direct link to Connections")
### Access Key and Secret[](#awsaccesskeysecret "Direct link to Access Key and Secret")
**key: awsAccessKeySecret**
An AWS IAM [access key pair](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) is required to interact with Redshift. Ensure the key pair generated in AWS has proper permissions to the Redshift resources to access. Read more about Redshift IAM actions in the [AWS docs](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html).
#### Setup Steps[](#setup-steps "Direct link to Setup Steps")
1. Sign in to the [AWS Console](https://aws.amazon.com/) and navigate to **Identity and Access Management (IAM)**
2. Under the **Access Keys** section, select **Create access key**
3. Once created, copy the **Access Key** and **Secret access key**
#### Configure the Connection[](#configure-the-connection "Direct link to Configure the Connection")
Create a connection of type **AWS Access Key/Secret Key** and enter:
* **Access Key ID**: The AWS Access Key ID
* **Secret Access Key**: The AWS Secret Access Key
| Input | Notes | Example |
| ----------------- | ----------------------------------------------------------------------------- | ---------------------------------------- |
| Access Key ID | The AWS Access Key ID used to authenticate requests to the Redshift Data API. | AKIAIOSFODNN7EXAMPLE |
| Secret Access Key | The AWS Secret Access Key paired with the Access Key ID for request signing. | wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY |
### AWS Role ARN[](#awsassumerole "Direct link to AWS Role ARN")
**key: awsAssumeRole**
To enable IAM role authentication, log in to the [AWS Console](https://aws.amazon.com/) and navigate to **Identity and Access Management (IAM)**.
#### Setup Steps[](#setup-steps-1 "Direct link to Setup Steps")
**Create an ARN user and generate credentials:**
1. Navigate to **Users** and select **Create User**.
* Provide a user name and check the box providing user access to the AWS Management Console if needed.
* Once the user is created, copy the ARN provided in the summary for a later step.
2. To obtain the ARN for an existing user, click on the designated username from the **Users** page and the ARN will be provided in the summary section.
3. From the summary section, select **Create access key**
* Select **Third-party service** as the access key type and select **Next**.
* Set a description and select **Create access key**.
* Copy the **Access Key** and **Secret access key** for use in the connection configuration.
**Create and assign a role:**
1. Navigate to **Roles** and select **Create Role**.
* Select **Custom Trust Policy** for the Trusted entity types.
* Copy the following statement into the statement console, replacing **ARN** with the user's actual ARN from the previous step:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "ARN"
},
"Action": "sts:AssumeRole"
}
]
}
```
* When adding permissions, provide the **redshift:\*** permission to grant access to all Redshift operations.
* Complete the remaining steps and select **Create Role**.
#### Configure the Connection[](#configure-the-connection-1 "Direct link to Configure the Connection")
Create a connection of type **AWS Role ARN** and enter:
* **Role ARN**: The ARN of the IAM role to assume (e.g., `arn:aws:iam::OtherAccount-ID:role/assumed-role-name`)
* **Access Key ID**: The AWS IAM Access Key ID
* **Secret Access Key**: The AWS IAM Secret Access Key
* **External ID** (optional): A shared secret for enhanced security; see the [AWS docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html#id_roles_third-party_external-id) for more information
| Input | Notes | Example |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| Access Key ID | An AWS IAM Access Key ID | AKIAIOSFODNN7EXAMPLE |
| External ID | Provides enhanced security measures to the connection. Optional, but recommended. Please check [AWS docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html#id_roles_third-party_external-id) for more information. | shared-common-secret |
| Role ARN | An AWS IAM Role ARN | arn:aws:iam::OtherAccount-ID:role/assumed-role-name |
| Secret Access Key | An AWS IAM Secret Access Key | wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY |
## Data Sources[](#data-sources "Direct link to Data Sources")
### Select AWS Region[](#selectregion "Direct link to Select AWS Region")
Select an AWS region | **key: selectRegion** | **type: picklist**
***
## Actions[](#actions "Direct link to Actions")
### Describe Statement[](#describestatement "Direct link to Describe Statement")
Get detailed information about a specific SQL statement in Redshift. | **key: describeStatement**
| Input | Notes | Example |
| -------------- | -------------------------------------------------------------------------------------- | ------------------------------------ |
| AWS Connection | Select the AWS connection to use for Redshift Data API access. | |
| AWS Region | AWS provides services in multiple regions, like us-west-2 or eu-west-1. | us-east-1 |
| Statement ID | The unique identifier of the executed SQL statement returned by the Redshift Data API. | 12345678-1234-1234-1234-123456789012 |
Example Payload for Describe Statement[⤓](https://prismatic.io/docs/example-payloads/aws-redshift/actions/describeStatement.json "Download example payload")
Loading…
***
### Execute SQL Statement[](#executestatement "Direct link to Execute SQL Statement")
Execute a SQL statement in Redshift. | **key: executeStatement**
| Input | Notes | Example |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| Additional Fields | Additional optional fields: includes Statement Name, Result Format, Session Keep Alive (seconds), Client Token, and Session ID. | |
| AWS Connection | Select the AWS connection to use for Redshift Data API access. | |
| AWS Region | AWS provides services in multiple regions, like us-west-2 or eu-west-1. | us-east-1 |
| Cluster Identifier | The identifier of the Redshift cluster. Required for cluster connections using either Secrets Manager or temporary credentials. | my-redshift-cluster |
| Database Name | The name of the database to connect to. This parameter is required when authenticating using either Secrets Manager or temporary credentials. | analytics |
| Database User | The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. | admin |
| Get Statement Result | When true, waits for the statement to finish executing and returns its result set. Only SELECT statements produce result rows. \Note:\ long-running statements may cause a timeout. | true |
| Secret ARN | The ARN of the AWS Secrets Manager secret containing database credentials. Required when authenticating using Secrets Manager. | arn:aws:secretsmanager:us-east-1:123456789012:secret:redshift-credentials |
| SQL Parameters | Named parameters that are substituted into the SQL statement at runtime using the colon-prefixed placeholder syntax (e.g., :status). | status: active, limit: 100 |
| SQL Statement | The SQL statement to run against the Redshift database. Supports DML (INSERT, UPDATE, DELETE), DDL (CREATE, DROP, ALTER), and query (SELECT) statements. | See Example |
| Workgroup Name | The name of the Redshift serverless workgroup. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials. | my-workgroup |
Example Payload for Execute SQL Statement[⤓](https://prismatic.io/docs/example-payloads/aws-redshift/actions/executeStatement.json "Download example payload")
Loading…
***
### Get Statement Result[](#getstatementresult "Direct link to Get Statement Result")
Retrieve the results of an executed SQL statement from Redshift. | **key: getStatementResult**
| Input | Notes | Example |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| AWS Connection | Select the AWS connection to use for Redshift Data API access. | |
| AWS Region | AWS provides services in multiple regions, like us-west-2 or eu-west-1. | us-east-1 |
| Next Token | The pagination token returned from a previous list request, used to retrieve the next page of results. | AQICAHi2k9rFZ... |
| Statement ID | The unique identifier of the executed SQL statement returned by the Redshift Data API. \Note:\ Only statements that return results are supported. | 12345678-1234-1234-1234-123456789012 |
Example Payload for Get Statement Result[⤓](https://prismatic.io/docs/example-payloads/aws-redshift/actions/getStatementResult.json "Download example payload")
Loading…
***
### List Statements[](#liststatements "Direct link to List Statements")
List executed SQL statements in Redshift. | **key: listStatements**
| Input | Notes | Example |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------- |
| AWS Connection | Select the AWS connection to use for Redshift Data API access. | |
| AWS Region | AWS provides services in multiple regions, like us-west-2 or eu-west-1. | us-east-1 |
| Fetch All | When enabled, automatically fetches all pages of results. Next Token and Max Results inputs are ignored when this is enabled. | false |
| Filters | Optional filters to narrow the returned statements by database, workgroup, cluster, and statement name. | |
| Pagination | Page and page-size controls. | |
| Status | Filters the returned statements to only those matching this execution status. Use ALL to retrieve statements in any state. | ALL |
Example Payload for List Statements[⤓](https://prismatic.io/docs/example-payloads/aws-redshift/actions/listStatements.json "Download example payload")
Loading…
***
### Raw Request[](#rawrequest "Direct link to Raw Request")
Send raw HTTP request to Redshift Data API. | **key: rawRequest**
| Input | Notes | Example |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- |
| Action | The Redshift Data API operation to invoke. Determines which API method is called with the provided body. | RedshiftData.ExecuteStatement |
| AWS Connection | Select the AWS connection to use for Redshift Data API access. | |
| AWS Region | AWS provides services in multiple regions, like us-west-2 or eu-west-1. | us-east-1 |
| Body | The JSON payload sent to the selected Redshift Data API operation. The required fields vary by action — refer to the AWS Redshift Data API documentation for the expected structure of each operation. | See Example |
***
## Changelog[](#changelog "Direct link to Changelog")
### 2026-08-05[](#2026-08-05 "Direct link to 2026-08-05")
Various modernizations and documentation updates
### 2026-07-16[](#2026-07-16 "Direct link to 2026-07-16")
Restructured action inputs into structured objects for an improved user experience.
* **Execute SQL Statement** groups its optional inputs (**Session ID**, **Statement Name**, **Result Format**, **Session Keep Alive (seconds)**, and **Client Token**) into **Additional Fields**
* **List Statements** groups its filter inputs (**Database Name**, **Workgroup Name**, **Cluster Identifier**, and **Statement Name**) into **Filters** and its pagination inputs (**Next Token** and **Max Results**) into **Pagination**
### 2026-05-28[](#2026-05-28 "Direct link to 2026-05-28")
Various modernizations and documentation updates
### 2026-05-21[](#2026-05-21 "Direct link to 2026-05-21")
Added **Fetch All** input to the **List Statements** action to automatically paginate through and return all SQL statements in a single response
### 2026-04-30[](#2026-04-30 "Direct link to 2026-04-30")
Updated spectral version
### 2026-03-20[](#2026-03-20 "Direct link to 2026-03-20")
Initial release of the Redshift component with comprehensive integration capabilities