How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Redshift Redshift Data API Service API

The Redshift Data API Service API from AWS Redshift — 10 operation(s) for redshift data api service.

This API exposes 10 operations across 10 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 2019-12-20.

Requests are made against 4 base URLs: http://redshift-data.{region}.amazonaws.com, https://redshift-data.{region}.amazonaws.com, http://redshift-data.{region}.amazonaws.com.cn, https://redshift-data.{region}.amazonaws.com.cn.

10 operations 10 paths 68 schemas 10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2019-12-20
Base URL
https://redshift-serverless.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Redshift Redshift Data API Service API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 10 POST. Each is listed below with its method, path, parameters, and response codes.

Redshift Data API Service 10
POST
/#X-Amz-Target=RedshiftData.BatchExecuteStatement
Amazon Redshift Data - Batch Execute Statement
BatchExecuteStatement 8 params body → 200480481482
POST
/#X-Amz-Target=RedshiftData.CancelStatement
Amazon Redshift Data - Cancel Statement
CancelStatement 8 params body → 200480481482483
POST
/#X-Amz-Target=RedshiftData.DescribeStatement
Amazon Redshift Data - Describe Statement
DescribeStatement 8 params body → 200480481482
POST
/#X-Amz-Target=RedshiftData.DescribeTable
Amazon Redshift Data - Describe Table
DescribeTable 10 params body → 200480481482
POST
/#X-Amz-Target=RedshiftData.ExecuteStatement
Amazon Redshift Data - Execute Statement
ExecuteStatement 8 params body → 200480481482
POST
/#X-Amz-Target=RedshiftData.GetStatementResult
Amazon Redshift Data - Get Statement Result
GetStatementResult 9 params body → 200480481482
POST
/#X-Amz-Target=RedshiftData.ListDatabases
Amazon Redshift Data - List Databases
ListDatabases 10 params body → 200480481482
POST
/#X-Amz-Target=RedshiftData.ListSchemas
Amazon Redshift Data - List Schemas
ListSchemas 10 params body → 200480481482
POST
/#X-Amz-Target=RedshiftData.ListStatements
Amazon Redshift Data - List Statements
ListStatements 10 params body → 200480481
POST
/#X-Amz-Target=RedshiftData.ListTables
Amazon Redshift Data - List Tables
ListTables 10 params body → 200480481482

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are DescribeStatementResponse (19 properties), ColumnMetadata (13 properties), SubStatementData (11 properties), ExecuteStatementInput (10 properties). Each schema is shown below with its type and property counts.

ExecuteStatementOutput
object
7 properties
BoxedLong
integer
ListStatementsRequest
object
5 properties
ListSchemasRequest
object
9 properties 1 required
Blob
string
DescribeTableRequest
object
10 properties 1 required
ClientToken
string
ColumnList
array
DatabaseList
array
StatementStatusString
string
SqlList
array
ColumnMetadata
object
The properties (metadata) of a column.
13 properties
BatchExecuteStatementOutput
object
7 properties
SqlParameter
object
A parameter used in a SQL statement.
2 properties 2 required
StatementData
object
The SQL statement to run.
10 properties 1 required
CancelStatementRequest
object
1 property 1 required
StatementNameString
string
GetStatementResultResponse
object
4 properties 1 required
StatementStringList
array
DescribeTableResponse
object
3 properties
InternalServerException
ListTablesRequest
object
10 properties 1 required
ListSchemasResponse
object
2 properties
ListStatementsResponse
object
2 properties 1 required
SqlRecords
array
FieldList
array
BoxedDouble
number
Location
string
StatementId
string
ActiveStatementsExceededException
DescribeStatementRequest
object
1 property 1 required
SqlParametersList
array
TableList
array
DescribeStatementResponse
object
19 properties 1 required
Field
object
A data value in a column.
6 properties
String
string
StatementList
array
ExecuteStatementException
PageSize
integer
GetStatementResultRequest
object
2 properties 1 required
StatusString
string
ResourceNotFoundException
ExecuteStatementInput
object
10 properties 2 required
SecretArn
string
TableMember
object
The properties of a table.
3 properties
Integer
integer
WorkgroupNameString
string
SubStatementList
array
ParameterValue
string
ListTablesResponse
object
2 properties
ListDatabasesResponse
object
2 properties
Boolean
boolean
ParameterName
string
BatchExecuteStatementInput
object
9 properties 2 required
ListDatabasesRequest
object
7 properties 1 required
BatchExecuteStatementException
DatabaseConnectionException
ValidationException
SchemaList
array
ListStatementsLimit
integer
CancelStatementResponse
object
1 property
StatementString
string
SubStatementData
object
Information about an SQL statement.
11 properties 1 required
Timestamp
string
BoxedBoolean
boolean
ColumnMetadataList
array
Long
integer
bool
boolean

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-redshift-redshift-data-api-service-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of AWS Redshift Redshift Data API Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.