Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Redshift #X Amz Target=RedshiftData.BatchExecuteStatement API

The #X Amz Target=RedshiftData.BatchExecuteStatement API from AWS Redshift — 1 operation(s) for #x amz target=redshiftdata.batchexecutestatement.

AWS Redshift #X Amz Target=RedshiftData.BatchExecuteStatement API is one of 130 APIs that AWS Redshift publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #X Amz Target=RedshiftData.BatchExecuteStatement. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 16 schemas. It is described by OpenAPI 3.0.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.

1 operations 1 paths 16 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

AWS Redshift #X Amz Target=RedshiftData.BatchExecuteStatement 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 1

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

#X Amz Target=RedshiftData.BatchExecuteStatement 1
POST
/#X-Amz-Target=RedshiftData.BatchExecuteStatement
Amazon Redshift Data - Batch Execute Statement
BatchExecuteStatement 8 params body → 200480481482

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are BatchExecuteStatementInput (9 properties), BatchExecuteStatementOutput (7 properties). Each schema is shown below with its type and property counts.

ActiveStatementsExceededException
WorkgroupNameString
string
BatchExecuteStatementInput
object
9 properties 2 required
SqlList
array
String
string
StatementNameString
string
StatementString
string
Location
string
StatementId
string
SecretArn
string
BatchExecuteStatementOutput
object
7 properties
Boolean
boolean
ClientToken
string
ValidationException
BatchExecuteStatementException
Timestamp
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-redshift-x-amz-target-redshiftdata-batchexecutestatement-api-openapi.yml Raw ↑

Other APIs AWS Redshift publishes across the network.

Amazon Redshift Serverless API
AWS Redshift #Action=AcceptReservedNodeExchange API
AWS Redshift #Action=AddPartner API
AWS Redshift #Action=AssociateDataShareConsumer API
AWS Redshift #Action=AuthorizeClusterSecurityGroupIngress API
AWS Redshift #Action=AuthorizeDataShare API
AWS Redshift #Action=AuthorizeEndpointAccess API
AWS Redshift #Action=AuthorizeSnapshotAccess API
AWS Redshift #Action=BatchDeleteClusterSnapshots API
AWS Redshift #Action=BatchModifyClusterSnapshots API
AWS Redshift #Action=CancelResize API
AWS Redshift #Action=CopyClusterSnapshot API