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 #Action=DescribeClusterVersions API

The #Action=DescribeClusterVersions API from AWS Redshift — 1 operation(s) for #action=describeclusterversions.

AWS Redshift #Action=DescribeClusterVersions 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 #Action=DescribeClusterVersions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 6 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.

2 operations 1 paths 6 schemas 1 GET1 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 #Action=DescribeClusterVersions 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 2

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

#Action=DescribeClusterVersions 2
GET
/#Action=DescribeClusterVersions
Amazon Redshift - G E T Describe Cluster Versions
GET_DescribeClusterVersions 13 params → 200
POST
/#Action=DescribeClusterVersions
Amazon Redshift - P O S T Describe Cluster Versions
POST_DescribeClusterVersions 11 params body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are DescribeClusterVersionsMessage (4 properties), ClusterVersion (3 properties), ClusterVersionsMessage (2 properties). Each schema is shown below with its type and property counts.

DescribeClusterVersionsMessage
object
4 properties
ClusterVersionsMessage
object
Contains the output from the DescribeClusterVersions action.
2 properties
IntegerOptional
integer
ClusterVersionList
array
String
string
ClusterVersion
object
Describes a cluster version, including the parameter group family and description of the version.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-redshift-action-describeclusterversions-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