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 2020 04 22 API

The 2020 04 22 API from APIs.io Engineering Platform — 3 operation(s) for 2020 04 22.

This API exposes 6 operations across 3 paths, and defines 24 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.

6 operations 3 paths 24 schemas 1 DELETE3 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 2020 04 22 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 6

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

2020 04 22 6
POST
/2020-04-22/code-signing-configs/
Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validati…
CreateCodeSigningConfig 7 params body → 201480481
GET
/2020-04-22/code-signing-configs/
Returns a list of code signing configurations . A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.
ListCodeSigningConfigs 9 params → 200480481
DELETE
/2020-04-22/code-signing-configs/{CodeSigningConfigArn}
Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.
DeleteCodeSigningConfig 8 params → 204480481482483
GET
/2020-04-22/code-signing-configs/{CodeSigningConfigArn}
Returns information about the specified code signing configuration.
GetCodeSigningConfig 8 params → 200480481482
PUT
/2020-04-22/code-signing-configs/{CodeSigningConfigArn}
Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.
UpdateCodeSigningConfig 8 params body → 200480481482
GET
/2020-04-22/code-signing-configs/{CodeSigningConfigArn}/functions
List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.
ListFunctionsByCodeSigningConfig 10 params → 200480481482

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are CodeSigningConfig (6 properties), ListCodeSigningConfigsResponse (2 properties), ListFunctionsByCodeSigningConfigResponse (2 properties), AllowedPublishers (1 property). Each schema is shown below with its type and property counts.

FunctionArn
string
ListFunctionsByCodeSigningConfigResponse
object
2 properties
CodeSigningConfig
object
Details about a Code signing configuration .
6 properties 5 required
Arn
string
GetCodeSigningConfigResponse
object
1 property 1 required
Timestamp
string
CodeSigningConfigArn
string
CreateCodeSigningConfigResponse
object
1 property 1 required
CodeSigningPolicy
string
ResourceConflictException
UpdateCodeSigningConfigResponse
object
1 property 1 required
InvalidParameterValueException
SigningProfileVersionArns
array
String
string
DeleteCodeSigningConfigResponse
object
CodeSigningConfigId
string
FunctionArnList
array
Description
string
ServiceException
ResourceNotFoundException
ListCodeSigningConfigsResponse
object
2 properties
CodeSigningPolicies
object
Code signing configuration policies specify the validation failure action for signature mismatch or expiry.
1 property
CodeSigningConfigList
array
AllowedPublishers
object
List of signing profiles that can sign a code package.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-2020-04-22-api-openapi.yml Raw ↑