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 2019 09 25 API

The 2019 09 25 API from APIs.io Engineering Platform — 2 operation(s) for 2019 09 25.

This API exposes 5 operations across 2 paths, and defines 17 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 17 schemas 1 DELETE2 GET1 POST1 PUT

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 2019 09 25 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 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

2019 09 25 5
DELETE
/2019-09-25/functions/{FunctionName}/event-invoke-config
Deletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig .
DeleteFunctionEventInvokeConfig 9 params → 204480481482483484
GET
/2019-09-25/functions/{FunctionName}/event-invoke-config
Retrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig .
GetFunctionEventInvokeConfig 9 params → 200480481482483
PUT
/2019-09-25/functions/{FunctionName}/event-invoke-config
Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any…
PutFunctionEventInvokeConfig 9 params body → 200480481482483484
POST
/2019-09-25/functions/{FunctionName}/event-invoke-config
Updates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig .
UpdateFunctionEventInvokeConfig 9 params body → 200480481482483484
GET
/2019-09-25/functions/{FunctionName}/event-invoke-config/list
Retrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig .
ListFunctionEventInvokeConfigs 10 params → 200480481482483

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are FunctionEventInvokeConfig (5 properties), ListFunctionEventInvokeConfigsResponse (2 properties), DestinationConfig (2 properties), OnSuccess (1 property). Each schema is shown below with its type and property counts.

TooManyRequestsException
DestinationArn
string
FunctionEventInvokeConfig
object
5 properties
FunctionArn
string
MaximumEventAgeInSeconds
integer
OnSuccess
object
A destination for events that were processed successfully.
1 property
ListFunctionEventInvokeConfigsResponse
object
2 properties
OnFailure
object
A destination for events that failed processing.
1 property
ResourceConflictException
InvalidParameterValueException
FunctionEventInvokeConfigList
array
String
string
DestinationConfig
object
A configuration object that specifies the destination of an event after Lambda processes it.
2 properties
ServiceException
Date
string
ResourceNotFoundException
MaximumRetryAttempts
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-2019-09-25-api-openapi.yml Raw ↑