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

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

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

This API exposes 2 operations across 1 path, and defines 9 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 9 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=DescribeClusterParameters 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=DescribeClusterParameters 2
GET
/#Action=DescribeClusterParameters
Amazon Redshift - G E T Describe Cluster Parameters
GET_DescribeClusterParameters 13 params → 200480
POST
/#Action=DescribeClusterParameters
Amazon Redshift - P O S T Describe Cluster Parameters
POST_DescribeClusterParameters 11 params body → 200480

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Parameter (9 properties), DescribeClusterParametersMessage (4 properties), ClusterParameterGroupDetails (2 properties). Each schema is shown below with its type and property counts.

Boolean
boolean
DescribeClusterParametersMessage
object
4 properties 1 required
IntegerOptional
integer
ClusterParameterGroupNotFoundFault
ParametersList
array
Parameter
object
Describes a parameter in a cluster parameter group.
9 properties
ClusterParameterGroupDetails
object
Contains the output from the DescribeClusterParameters action.
2 properties
String
string
ParameterApplyType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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