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

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

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

This API exposes 2 operations across 1 path, and defines 12 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 12 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=DescribeReservedNodeExchangeStatus 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=DescribeReservedNodeExchangeStatus 2
GET
/#Action=DescribeReservedNodeExchangeStatus
Amazon Redshift - G E T Describe Reserved Node Exchange Status
GET_DescribeReservedNodeExchangeStatus 13 params → 200480481482
POST
/#Action=DescribeReservedNodeExchangeStatus
Amazon Redshift - P O S T Describe Reserved Node Exchange Status
POST_DescribeReservedNodeExchangeStatus 11 params body → 200480481482

Schemas 12

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

TStamp
string
ReservedNodeExchangeStatusType
string
Integer
integer
ReservedNodeExchangeStatusList
array
String
string
ReservedNodeExchangeStatus
object
Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other detail…
9 properties
ReservedNodeExchangeNotFoundFault
DescribeReservedNodeExchangeStatusOutputMessage
object
2 properties
DescribeReservedNodeExchangeStatusInputMessage
object
4 properties
ReservedNodeNotFoundFault
IntegerOptional
integer
UnsupportedOperationFault

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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