Amazon Redshift

App · 11 actions

Run SQL with the Redshift Data API and read databases, schemas, tables, statements and query results.

Actions

ActionWhat it does
Batch execute statementBatch execute statement.
Cancel statementCancel statement.
Describe statementDescribe statement.
Describe tableDescribe table.
Execute statementExecute statement.
Get statement resultGet statement result.
Get statement result v2Get statement result v2.
List databasesList databases.
List schemasList schemas.
List statementsList statements.
List tablesList tables.

Batch execute statement

Batch execute statement. Returns the service response.

Inputs

SqlssqlslistRequired
Sqls.
Cluster identifiercluster_identifiertext
Clusteridentifier.
Secret arnsecret_arntext
Secretarn.
Db userdb_usertext
Dbuser.
Databasedatabasetext
Database. Leave empty to use the connected database.
With eventwith_eventtrue/false
Withevent.
Statement namestatement_nametext
Statementname.
Parametersparameterslist
Parameters.
Workgroup nameworkgroup_nametext
Workgroupname.
Client tokenclient_tokentext
Clienttoken.
Result formatresult_formattext
Resultformat.One of: JSON, CSV.
Session keep alive secondssession_keep_alive_secondsnumber
Sessionkeepaliveseconds.
Session idsession_idtext
Sessionid.
Execution modeexecution_modetext
Executionmode.One of: TRANSACTION, AUTO_COMMIT.
Wait time secondswait_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

IdidtextRequired
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

IdidtextRequired
Id.
Wait time secondswait_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 identifiercluster_identifiertext
Clusteridentifier.
Secret arnsecret_arntext
Secretarn.
Db userdb_usertext
Dbuser.
Databasedatabasetext
Database. Leave empty to use the connected database.
Connected databaseconnected_databasetext
Connecteddatabase.
Schemaschematext
Schema.
Tabletabletext
Table.
Next page cursornext_tokentext
Nexttoken.
Page sizemax_resultsnumber
Maxresults.
Workgroup nameworkgroup_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

SqlsqltextRequired
Sql.
Cluster identifiercluster_identifiertext
Clusteridentifier.
Secret arnsecret_arntext
Secretarn.
Db userdb_usertext
Dbuser.
Databasedatabasetext
Database. Leave empty to use the connected database.
With eventwith_eventtrue/false
Withevent.
Statement namestatement_nametext
Statementname.
Parametersparameterslist
Parameters.
Workgroup nameworkgroup_nametext
Workgroupname.
Client tokenclient_tokentext
Clienttoken.
Result formatresult_formattext
Resultformat.One of: JSON, CSV.
Session keep alive secondssession_keep_alive_secondsnumber
Sessionkeepaliveseconds.
Session idsession_idtext
Sessionid.
Wait time secondswait_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

IdidtextRequired
Id.
Next page cursornext_tokentext
Nexttoken.
Wait time secondswait_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

IdidtextRequired
Id.
Next page cursornext_tokentext
Nexttoken.
Wait time secondswait_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 identifiercluster_identifiertext
Clusteridentifier.
Databasedatabasetext
Database. Leave empty to use the connected database.
Secret arnsecret_arntext
Secretarn.
Db userdb_usertext
Dbuser.
Next page cursornext_tokentext
Nexttoken.
Page sizemax_resultsnumber
Maxresults.
Workgroup nameworkgroup_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 identifiercluster_identifiertext
Clusteridentifier.
Secret arnsecret_arntext
Secretarn.
Db userdb_usertext
Dbuser.
Databasedatabasetext
Database. Leave empty to use the connected database.
Connected databaseconnected_databasetext
Connecteddatabase.
Schema patternschema_patterntext
Schemapattern.
Next page cursornext_tokentext
Nexttoken.
Page sizemax_resultsnumber
Maxresults.
Workgroup nameworkgroup_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 cursornext_tokentext
Nexttoken.
Page sizemax_resultsnumber
Maxresults.
Statement namestatement_nametext
Statementname.
Statusstatustext
Status.One of: SUBMITTED, PICKED, STARTED, FINISHED, ABORTED, FAILED, ALL.
Role levelrole_leveltrue/false
Rolelevel.
Databasedatabasetext
Database. Leave empty to use the connected database.
Cluster identifiercluster_identifiertext
Clusteridentifier.
Workgroup nameworkgroup_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 identifiercluster_identifiertext
Clusteridentifier.
Secret arnsecret_arntext
Secretarn.
Db userdb_usertext
Dbuser.
Databasedatabasetext
Database. Leave empty to use the connected database.
Connected databaseconnected_databasetext
Connecteddatabase.
Schema patternschema_patterntext
Schemapattern.
Table patterntable_patterntext
Tablepattern.
Next page cursornext_tokentext
Nexttoken.
Page sizemax_resultsnumber
Maxresults.
Workgroup nameworkgroup_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"
}

On this page