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 2021 11 15 API

The 2021 11 15 API from APIs.io Engineering Platform — 1 operation(s) for 2021 11 15.

This API exposes 1 operation across 1 path, and defines 36 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.

1 operations 1 paths 36 schemas 1 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 2021 11 15 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

2021 11 15 1
POST
/2021-11-15/functions/{FunctionName}/response-streaming-invocations
Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses . This operation requires permission for the l…
InvokeWithResponseStream 12 params body → 200480481482483484485486

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are InvokeWithResponseStreamCompleteEvent (3 properties), InvokeWithResponseStreamResponseEvent (2 properties), InvokeWithResponseStreamResponse (2 properties), InvokeResponseStreamUpdate (1 property). Each schema is shown below with its type and property counts.

KMSInvalidStateException
TooManyRequestsException
EFSMountFailureException
KMSNotFoundException
ResourceNotReadyException
EC2ThrottledException
InvokeResponseStreamUpdate
object
A chunk of the streamed response payload.
1 property
Integer
integer
SnapStartNotReadyException
InvokeWithResponseStreamResponseEvent
object
An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a InvokeComplete object.
2 properties
InvalidZipFileException
KMSDisabledException
InvalidSubnetIDException
ResourceConflictException
InvalidRequestContentException
InvalidParameterValueException
ENILimitReachedException
EFSIOException
String
string
KMSAccessDeniedException
InvokeWithResponseStreamResponse
object
2 properties
InvokeWithResponseStreamCompleteEvent
object
A response confirming that the event stream is complete.
3 properties
SnapStartTimeoutException
EFSMountTimeoutException
ServiceException
InvalidRuntimeException
InvalidSecurityGroupIDException
ResourceNotFoundException
EC2AccessDeniedException
EFSMountConnectivityException
Blob
string
SubnetIPAddressLimitReachedException
UnsupportedMediaTypeException
RequestTooLargeException
SnapStartException
EC2UnexpectedException

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-2021-11-15-api-openapi.yml Raw ↑