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

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

AWS Redshift #Action=DescribeDataShares 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=DescribeDataShares. 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=DescribeDataShares 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=DescribeDataShares 2
GET
/#Action=DescribeDataShares
Amazon Redshift - G E T Describe Data Shares
GET_DescribeDataShares 12 params → 200480
POST
/#Action=DescribeDataShares
Amazon Redshift - P O S T Describe Data Shares
POST_DescribeDataShares 11 params body → 200480

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are DataShareAssociation (5 properties), DataShare (5 properties), DescribeDataSharesMessage (3 properties), DescribeDataSharesResult (2 properties). Each schema is shown below with its type and property counts.

DataShareStatus
string
TStamp
string
DataShareAssociationList
array
DataShare
object
5 properties
String
string
InvalidDataShareFault
DataShareList
array
Boolean
boolean
IntegerOptional
integer
DataShareAssociation
object
The association of a datashare from a producer account with a data consumer.
5 properties
DescribeDataSharesMessage
object
3 properties
DescribeDataSharesResult
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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