Redshift Data API Service
You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds.…
Data & analytics#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide .
Endpoints 12
- POSTBatch execute statement
/#X-Amz-Target=RedshiftData.BatchExecuteStatementRuns one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use… - POSTCancel statement
/#X-Amz-Target=RedshiftData.CancelStatementCancels a running query. To be canceled, a query must be running. For more information about the Amazon Redshift Data API and CLI usage examples, see Using… - POSTDescribe statement
/#X-Amz-Target=RedshiftData.DescribeStatementDescribes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it… - POSTDescribe table
/#X-Amz-Target=RedshiftData.DescribeTableDescribes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the… - POSTExecute statement
/#X-Amz-Target=RedshiftData.ExecuteStatementRuns an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement.… - POSTGet statement result
/#X-Amz-Target=RedshiftData.GetStatementResultFetches the temporarily cached result of an SQL statement in JSON format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement… - POSTGet statement result v2
/#X-Amz-Target=RedshiftData.GetStatementResultV2Fetches the temporarily cached result of an SQL statement in CSV format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement… - POSTList databases
/#X-Amz-Target=RedshiftData.ListDatabasesList the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following… - POSTList schemas
/#X-Amz-Target=RedshiftData.ListSchemasLists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following… - POSTList sessions
/#X-Amz-Target=RedshiftData.ListSessionsLists the sessions that the caller created in the last 24 hours. By default, only sessions with a status of AVAILABLE or BUSY are returned. You can filter the… - POSTList statements
/#X-Amz-Target=RedshiftData.ListStatementsList of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list. When you use identity-enhanced… - POSTList tables
/#X-Amz-Target=RedshiftData.ListTablesList the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to…
API details
- Base URL
https://redshift-data.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 12 operations on 12 pathsPOST 12
- Description format
- AWS Smithy model, API version
2019-12-20 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Redshift Data API Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Redshift Data API Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Batch execute statement” (POST /#X-Amz-Target=RedshiftData.BatchExecuteStatement), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Redshift Data API Service?
You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds.… It is listed under Data & analytics and has 12 endpoints.
Who publishes the Redshift Data API Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Redshift Data API Service?
Requests go to https://redshift-data.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Redshift Data API Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Redshift Data API Service have?
12 operations on 12 paths (12 POST).
Is forking the Redshift Data API Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.