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

APIs.io Engineering Platform Vpclinks API

The Vpclinks API from APIs.io Engineering Platform — 2 operation(s) for vpclinks.

This API exposes 5 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

5 operations 2 paths 15 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Vpclinks 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Vpclinks 5
POST
/vpclinks
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions…
CreateVpcLink 7 params body → 202480481482483484
GET
/vpclinks
Gets the VpcLinks collection under the caller's account in a selected region.
GetVpcLinks 9 params → 200480481482483
DELETE
/vpclinks/{vpclink_id}
Deletes an existing VpcLink of a specified identifier.
DeleteVpcLink 8 params → 202480481482483484
GET
/vpclinks/{vpclink_id}
Gets a specified VPC link under the caller's account in a region.
GetVpcLink 8 params → 200480481482483
PATCH
/vpclinks/{vpclink_id}
Updates an existing VpcLink of a specified identifier.
UpdateVpcLink 8 params body → 200480481482483484485

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are VpcLink (7 properties), PatchOperation (4 properties), VpcLinks (2 properties). Each schema is shown below with its type and property counts.

VpcLinks
object
The collection of VPC links under the caller's account in a region.
2 properties
TooManyRequestsException
NotFoundException
Op
string
UnauthorizedException
ConflictException
VpcLink
object
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
7 properties
BadRequestException
PatchOperation
object
For more information about supported patch operations, see Patch Operations .
4 properties
LimitExceededException
ListOfVpcLink
array
String
string
VpcLinkStatus
string
ListOfString
array
MapOfStringToString
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-vpclinks-api-openapi.yml Raw ↑