Amazon Redshift
App · 11 actions
Run SQL with the Redshift Data API and read databases, schemas, tables, statements and query results.
Actions
| Action | What it does |
|---|---|
| Batch execute statement | Batch execute statement. |
| Cancel statement | Cancel statement. |
| Describe statement | Describe statement. |
| Describe table | Describe table. |
| Execute statement | Execute statement. |
| Get statement result | Get statement result. |
| Get statement result v2 | Get statement result v2. |
| List databases | List databases. |
| List schemas | List schemas. |
| List statements | List statements. |
| List tables | List tables. |
Batch execute statement
Batch execute statement. Returns the service response.
Inputs
- Sqls
sqlslistRequired - Sqls.
- Cluster identifier
cluster_identifiertext - Clusteridentifier.
- Secret arn
secret_arntext - Secretarn.
- Db user
db_usertext - Dbuser.
- Database
databasetext - Database. Leave empty to use the connected database.
- With event
with_eventtrue/false - Withevent.
- Statement name
statement_nametext - Statementname.
- Parameters
parameterslist - Parameters.
- Workgroup name
workgroup_nametext - Workgroupname.
- Client token
client_tokentext - Clienttoken.
- Result format
result_formattext - Resultformat.One of:
JSON,CSV. - Session keep alive seconds
session_keep_alive_secondsnumber - Sessionkeepaliveseconds.
- Session id
session_idtext - Sessionid.
- Execution mode
execution_modetext - Executionmode.One of:
TRANSACTION,AUTO_COMMIT. - Wait time seconds
wait_time_secondsnumber - Waittimeseconds.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"ClusterIdentifier": "example",
"CreatedAt": "2026-01-01T00:00:00Z",
"Database": "example",
"DbGroups": [],
"DbUser": "example",
"HasResultSet": false,
"Id": "example",
"RedshiftPid": 1,
"SecretArn": "example",
"SessionId": "example",
"Status": "SUBMITTED",
"WorkgroupName": "example"
},
"has_more": false,
"next_cursor": "example"
}Cancel statement
Cancel statement. Returns the service response.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"Status": false
},
"has_more": false,
"next_cursor": "example"
}Describe statement
Describe statement. Returns the service response.
Inputs
- Id
idtextRequired - Id.
- Wait time seconds
wait_time_secondsnumber - Waittimeseconds.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"ClusterIdentifier": "example",
"CreatedAt": "2026-01-01T00:00:00Z",
"Database": "example",
"DbUser": "example",
"Duration": 1,
"Error": "example",
"ExecutionMode": "TRANSACTION",
"HasResultSet": false,
"Id": "example",
"QueryParameters": [],
"QueryString": "example",
"RedshiftPid": 1,
"RedshiftQueryId": 1,
"RedshiftQueryUuid": "example",
"ResultFormat": "JSON",
"ResultRows": 1,
"ResultSize": 1,
"SecretArn": "example",
"SessionId": "example",
"Status": "SUBMITTED",
"SubStatements": [],
"UpdatedAt": "2026-01-01T00:00:00Z",
"WorkgroupName": "example"
},
"has_more": false,
"next_cursor": "example"
}Describe table
Describe table. Returns one page; use the next page cursor to continue.
Inputs
- Cluster identifier
cluster_identifiertext - Clusteridentifier.
- Secret arn
secret_arntext - Secretarn.
- Db user
db_usertext - Dbuser.
- Database
databasetext - Database. Leave empty to use the connected database.
- Connected database
connected_databasetext - Connecteddatabase.
- Schema
schematext - Schema.
- Table
tabletext - Table.
- Next page cursor
next_tokentext - Nexttoken.
- Page size
max_resultsnumber - Maxresults.
- Workgroup name
workgroup_nametext - Workgroupname.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"ColumnList": [],
"NextToken": "example",
"Records": [],
"TableName": "example"
},
"has_more": false,
"next_cursor": "example"
}Execute statement
Execute statement. Returns the service response.
Inputs
- Sql
sqltextRequired - Sql.
- Cluster identifier
cluster_identifiertext - Clusteridentifier.
- Secret arn
secret_arntext - Secretarn.
- Db user
db_usertext - Dbuser.
- Database
databasetext - Database. Leave empty to use the connected database.
- With event
with_eventtrue/false - Withevent.
- Statement name
statement_nametext - Statementname.
- Parameters
parameterslist - Parameters.
- Workgroup name
workgroup_nametext - Workgroupname.
- Client token
client_tokentext - Clienttoken.
- Result format
result_formattext - Resultformat.One of:
JSON,CSV. - Session keep alive seconds
session_keep_alive_secondsnumber - Sessionkeepaliveseconds.
- Session id
session_idtext - Sessionid.
- Wait time seconds
wait_time_secondsnumber - Waittimeseconds.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"ClusterIdentifier": "example",
"CreatedAt": "2026-01-01T00:00:00Z",
"Database": "example",
"DbGroups": [],
"DbUser": "example",
"HasResultSet": false,
"Id": "example",
"RedshiftPid": 1,
"SecretArn": "example",
"SessionId": "example",
"Status": "SUBMITTED",
"WorkgroupName": "example"
},
"has_more": false,
"next_cursor": "example"
}Get statement result
Get statement result. Returns one page; use the next page cursor to continue.
Inputs
- Id
idtextRequired - Id.
- Next page cursor
next_tokentext - Nexttoken.
- Wait time seconds
wait_time_secondsnumber - Waittimeseconds.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"ColumnMetadata": [],
"NextToken": "example",
"Records": [],
"TotalNumRows": 1
},
"has_more": false,
"next_cursor": "example"
}Get statement result v2
Get statement result v2. Returns one page; use the next page cursor to continue.
Inputs
- Id
idtextRequired - Id.
- Next page cursor
next_tokentext - Nexttoken.
- Wait time seconds
wait_time_secondsnumber - Waittimeseconds.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"ColumnMetadata": [],
"NextToken": "example",
"Records": [],
"ResultFormat": "JSON",
"TotalNumRows": 1
},
"has_more": false,
"next_cursor": "example"
}List databases
List databases. Returns one page; use the next page cursor to continue.
Inputs
- Cluster identifier
cluster_identifiertext - Clusteridentifier.
- Database
databasetext - Database. Leave empty to use the connected database.
- Secret arn
secret_arntext - Secretarn.
- Db user
db_usertext - Dbuser.
- Next page cursor
next_tokentext - Nexttoken.
- Page size
max_resultsnumber - Maxresults.
- Workgroup name
workgroup_nametext - Workgroupname.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"Databases": [],
"NextToken": "example"
},
"has_more": false,
"next_cursor": "example"
}List schemas
List schemas. Returns one page; use the next page cursor to continue.
Inputs
- Cluster identifier
cluster_identifiertext - Clusteridentifier.
- Secret arn
secret_arntext - Secretarn.
- Db user
db_usertext - Dbuser.
- Database
databasetext - Database. Leave empty to use the connected database.
- Connected database
connected_databasetext - Connecteddatabase.
- Schema pattern
schema_patterntext - Schemapattern.
- Next page cursor
next_tokentext - Nexttoken.
- Page size
max_resultsnumber - Maxresults.
- Workgroup name
workgroup_nametext - Workgroupname.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"NextToken": "example",
"Schemas": []
},
"has_more": false,
"next_cursor": "example"
}List statements
List statements. Returns one page; use the next page cursor to continue.
Inputs
- Next page cursor
next_tokentext - Nexttoken.
- Page size
max_resultsnumber - Maxresults.
- Statement name
statement_nametext - Statementname.
- Status
statustext - Status.One of:
SUBMITTED,PICKED,STARTED,FINISHED,ABORTED,FAILED,ALL. - Role level
role_leveltrue/false - Rolelevel.
- Database
databasetext - Database. Leave empty to use the connected database.
- Cluster identifier
cluster_identifiertext - Clusteridentifier.
- Workgroup name
workgroup_nametext - Workgroupname.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"NextToken": "example",
"Statements": []
},
"has_more": false,
"next_cursor": "example"
}List tables
List tables. Returns one page; use the next page cursor to continue.
Inputs
- Cluster identifier
cluster_identifiertext - Clusteridentifier.
- Secret arn
secret_arntext - Secretarn.
- Db user
db_usertext - Dbuser.
- Database
databasetext - Database. Leave empty to use the connected database.
- Connected database
connected_databasetext - Connecteddatabase.
- Schema pattern
schema_patterntext - Schemapattern.
- Table pattern
table_patterntext - Tablepattern.
- Next page cursor
next_tokentext - Nexttoken.
- Page size
max_resultsnumber - Maxresults.
- Workgroup name
workgroup_nametext - Workgroupname.
Outputs
dataobject- The complete service response.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page cursor.
Example output
{
"data": {
"NextToken": "example",
"Tables": []
},
"has_more": false,
"next_cursor": "example"
}