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=DescribeOrderableClusterOptions API

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

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

This API exposes 2 operations across 1 path, and defines 10 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 10 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=DescribeOrderableClusterOptions 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=DescribeOrderableClusterOptions 2
GET
/#Action=DescribeOrderableClusterOptions
Amazon Redshift - G E T Describe Orderable Cluster Options
GET_DescribeOrderableClusterOptions 13 params → 200
POST
/#Action=DescribeOrderableClusterOptions
Amazon Redshift - P O S T Describe Orderable Cluster Options
POST_DescribeOrderableClusterOptions 11 params body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are DescribeOrderableClusterOptionsMessage (4 properties), OrderableClusterOption (4 properties), AvailabilityZone (2 properties), OrderableClusterOptionsMessage (2 properties). Each schema is shown below with its type and property counts.

SupportedPlatformsList
array
AvailabilityZoneList
array
IntegerOptional
integer
SupportedPlatform
object
A list of supported platforms for orderable clusters.
1 property
AvailabilityZone
object
Describes an availability zone.
2 properties
OrderableClusterOptionsList
array
DescribeOrderableClusterOptionsMessage
object
4 properties
OrderableClusterOptionsMessage
object
Contains the output from the DescribeOrderableClusterOptions action.
2 properties
String
string
OrderableClusterOption
object
Describes an orderable cluster option.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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