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

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

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

This API exposes 2 operations across 1 path, and defines 21 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 21 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=CreateEndpointAccess 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=CreateEndpointAccess 2
GET
/#Action=CreateEndpointAccess
Amazon Redshift - G E T Create Endpoint Access
GET_CreateEndpointAccess 14 params → 200480481482483484485486
POST
/#Action=CreateEndpointAccess
Amazon Redshift - P O S T Create Endpoint Access
POST_CreateEndpointAccess 9 params body → 200480481482483484485486

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are EndpointAccess (10 properties), CreateEndpointAccessMessage (5 properties), NetworkInterface (4 properties), VpcEndpoint (3 properties). Each schema is shown below with its type and property counts.

NetworkInterface
object
Describes a network interface.
4 properties
TStamp
string
Integer
integer
AccessToClusterDeniedFault
EndpointsPerAuthorizationLimitExceededFault
String
string
UnauthorizedOperation
EndpointAccess
object
Describes a Redshift-managed VPC endpoint.
10 properties
EndpointsPerClusterLimitExceededFault
VpcSecurityGroupIdList
array
ClusterSubnetGroupNotFoundFault
NetworkInterfaceList
array
InvalidClusterStateFault
VpcEndpoint
object
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
3 properties
CreateEndpointAccessMessage
object
5 properties 2 required
VpcSecurityGroupMembership
object
Describes the members of a VPC security group.
2 properties
InvalidClusterSecurityGroupStateFault
EndpointAlreadyExistsFault
VpcSecurityGroupMembershipList
array
UnsupportedOperationFault
ClusterNotFoundFault

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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