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

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

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

This API exposes 2 operations across 1 path, and defines 14 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 14 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=AuthorizeEndpointAccess 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=AuthorizeEndpointAccess 2
GET
/#Action=AuthorizeEndpointAccess
Amazon Redshift - G E T Authorize Endpoint Access
GET_AuthorizeEndpointAccess 12 params → 200480481482483484485
POST
/#Action=AuthorizeEndpointAccess
Amazon Redshift - P O S T Authorize Endpoint Access
POST_AuthorizeEndpointAccess 9 params body → 200480481482483484485

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are EndpointAuthorization (9 properties), AuthorizeEndpointAccessMessage (3 properties). Each schema is shown below with its type and property counts.

EndpointAuthorizationAlreadyExistsFault
TStamp
string
Integer
integer
String
string
EndpointAuthorizationsPerClusterLimitExceededFault
InvalidAuthorizationStateFault
AuthorizeEndpointAccessMessage
object
3 properties 1 required
AuthorizationStatus
string
InvalidClusterStateFault
Boolean
boolean
VpcIdentifierList
array
UnsupportedOperationFault
EndpointAuthorization
object
Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across Amazon Web Services accounts.
9 properties
ClusterNotFoundFault

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-redshift-action-authorizeendpointaccess-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=AuthorizeSnapshotAccess API
AWS Redshift #Action=BatchDeleteClusterSnapshots API
AWS Redshift #Action=BatchModifyClusterSnapshots API
AWS Redshift #Action=CancelResize API
AWS Redshift #Action=CopyClusterSnapshot API
AWS Redshift #Action=CreateAuthenticationProfile API